This project is developed by the Ellrott Lab at the Knight Cancer Institute in PDX, Oregon.
The following resources will be created for every tag pushed to GitHub:
| Resource | Example |
|---|---|
| Tag | v0.11.6 |
| Docker image | quay.io/ohsu-comp-bio/funnel:v0.11.6 |
| GitHub Release | v0.11.6 |
| Homebrew Package | Funnel@v0.11.6 |
sequenceDiagram
participant dev as Developer
participant gh as GitHub
participant quay as Docker (Quay.io)
participant hb as Homebrew
participant go as pkg.go.dev
dev->>gh: git push origin <TAG>
gh-->>quay: tag
gh-->>quay: commit
gh-->>hb: tag
gh-->>go: tag
Funnel releases follow semantic versioning and are automatically built using the Semantic Version package and it's GitHub Action via release.yaml.
| Commit Type | Example Commit | Release |
|---|---|---|
| fix | fix: example message |
Patch Release: v0.1.0 → v0.1.1 |
| feat | feat: example message |
Minor Release: v0.1.0 → v0.2.0 |
| breaking | example: example messageBREAKING CHANGE: example description |
Major Release: v0.1.0 → v1.0.0 |
Tip
For a full list of commit types see Angualar's Commit Message Format and the Convention Commits spec
You can propose changes to Funnel by opening issues or pull requests for discussion and review. For substantial changes, we recommend starting with an issue to discuss scope and feasibility.
When submitting pull requests, please use your own fork—even if you have write access to the repository. This helps keep the main repository clean and organized.
If you discover a security vulnerability, please email mailto:security-notification@ga4gh.org with details.
Made with contrib.rocks.