-
Notifications
You must be signed in to change notification settings - Fork 0
chore(main): release 1.0.0 #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
f42c135
to
8c57962
Compare
e0a7e5e
to
96f8abf
Compare
d6e6d70
to
25cb921
Compare
25cb921
to
9086777
Compare
58b18c7
to
3b588fa
Compare
3b588fa
to
6ff58c9
Compare
6ff58c9
to
ba9666e
Compare
WalkthroughAdds a new 1.0.0 release entry to CHANGELOG.md dated 2025-08-26. The entry documents many additive features (gnomAD SV/CNV 4.0, MinIO, Traefik, cadd-rest-api support, download-data.sh, Nginx, Exomiser templates, etc.) and multiple bug fixes and version bumps; no public APIs were changed. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User as Developer/User
participant Traefik as Traefik (Ingress)
participant Nginx as Nginx (track server)
participant CADD as cadd-rest-api
participant MinIO as MinIO (object storage)
participant Downloader as download-data.sh / Workers
Note over User,Traefik: New release adds services & download flow
User->>Traefik: HTTP requests
Traefik->>CADD: route cadd requests
Traefik->>Nginx: route static track requests
Traefik->>MinIO: route S3-compatible requests
Downloader->>MinIO: upload/download data (via minio-client)
Downloader->>Nginx: place served track data
Note right of MinIO: Policy updated (s3:GetBucketLocation)
Note over Downloader,MinIO: graceful shutdown supported
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (2)
6-20
: Consider grouping features by theme for better readability.While the feature entries are well-documented with proper issue linking, consider organizing them into thematic groups such as:
- Infrastructure (MinIO, traefik, nginx)
- Data Sources (gnomAD, ClinVar)
- Tooling (download scripts, templates)
- Dependencies (version bumps)
22-43
: Enhance bug fix descriptions with impact context.Consider adding brief impact descriptions to bug fixes. For example:
- "adding s3:GetBucketLocation to minio policy" could be "fix: add s3:GetBucketLocation to MinIO policy to resolve bucket access issues"
- "seqdup => segdup" could be "fix: correct seqdup to segdup naming for consistency with upstream changes"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- CHANGELOG.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
CHANGELOG.md (1)
1-5
: LGTM! Header follows changelog best practices.The version header is properly formatted with semantic versioning and ISO 8601 date format.
* using bitnami minio clients to startup works again ([#36](https://github.com/varfish-org/varfish-docker-compose/issues/36)) ([7e199f3](https://github.com/varfish-org/varfish-docker-compose/commit/7e199f373d57ef9d97c38e1367a63fbac95c876b)) | ||
* various version changes ([#82](https://github.com/varfish-org/varfish-docker-compose/issues/82)) ([fd050b9](https://github.com/varfish-org/varfish-docker-compose/commit/fd050b9edf83473be490dfa5d621481d2477d5a5)) | ||
|
||
## Changelog |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove duplicate Changelog header.
The "## Changelog" header at line 45 appears to be a duplicate of the main header and should be removed.
-## Changelog
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
## Changelog |
ba9666e
to
a8c34fd
Compare
a8c34fd
to
0f6f29d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (1)
CHANGELOG.md (1)
47-47
: Remove duplicate “Changelog” header at the end.There’s an extra “## Changelog” header left over at the bottom; drop it to avoid confusion with the top-level title.
Apply this diff:
-## Changelog
🧹 Nitpick comments (8)
CHANGELOG.md (8)
28-28
: Deduplicate segdup/seqdup bullets or clarify differences.Two bullets describe the segdup change (Lines 28 and 40). If they refer to the same change, keep one. If distinct (e.g., code vs. docs), clarify scope in one of them.
If they are duplicates, remove the later one:
-* seqdup => segdup ([083c66f](https://github.com/varfish-org/varfish-docker-compose/commit/083c66fdfe20ed6e985c52109e2ffc5e3eebe4de))
Also applies to: 40-40
17-17
: Potential duplicate “annonars genes” bump entries.Lines 17 (“bump annonars/genes”) and 33 (“bump version in annonars genes”) might be redundant. If they represent different repos/components or separate bumps, add a brief qualifier (e.g., “(docker image)” vs “(dataset)”). Otherwise, dedupe.
Also applies to: 33-33
10-10
: Fix product capitalization (Traefik, Nginx, Exomiser).Use canonical brand casing for readability and consistency.
Apply this diff:
-* add traefik service with configuration examples ([#3](https://github.com/varfish-org/varfish-docker-compose/issues/3)) ([#5](https://github.com/varfish-org/varfish-docker-compose/issues/5)) ([8cfbc21](https://github.com/varfish-org/varfish-docker-compose/commit/8cfbc21cccdf3508335deb9ebe6eefb96ee49a3f)) +* add Traefik service with configuration examples ([#3](https://github.com/varfish-org/varfish-docker-compose/issues/3)) ([#5](https://github.com/varfish-org/varfish-docker-compose/issues/5)) ([8cfbc21](https://github.com/varfish-org/varfish-docker-compose/commit/8cfbc21cccdf3508335deb9ebe6eefb96ee49a3f)) -* adding nginx for serving track data ([#15](https://github.com/varfish-org/varfish-docker-compose/issues/15)) ([#20](https://github.com/varfish-org/varfish-docker-compose/issues/20)) ([973b640](https://github.com/varfish-org/varfish-docker-compose/commit/973b6400f93199dd3d6c39e9226a874cdf3fbf05)) +* adding Nginx for serving track data ([#15](https://github.com/varfish-org/varfish-docker-compose/issues/15)) ([#20](https://github.com/varfish-org/varfish-docker-compose/issues/20)) ([973b640](https://github.com/varfish-org/varfish-docker-compose/commit/973b6400f93199dd3d6c39e9226a874cdf3fbf05)) -* adding templates for exomiser integration ([#46](https://github.com/varfish-org/varfish-docker-compose/issues/46)) ([dea2c78](https://github.com/varfish-org/varfish-docker-compose/commit/dea2c787324960b8da64ddf283ef76e1a43f8323)) +* adding templates for Exomiser integration ([#46](https://github.com/varfish-org/varfish-docker-compose/issues/46)) ([dea2c78](https://github.com/varfish-org/varfish-docker-compose/commit/dea2c787324960b8da64ddf283ef76e1a43f8323))Also applies to: 15-16
11-16
: Prefer imperative mood for bullet verbs in Features.Conventional Changelog style uses imperative (“add”, “bump”, “update”) instead of gerunds (“adding”, “bumping”). Improves consistency.
Apply this diff:
-* adding cadd-rest-api support via docker-compose.override.yml ([#48](https://github.com/varfish-org/varfish-docker-compose/issues/48)) ([c9d6c6c](https://github.com/varfish-org/varfish-docker-compose/commit/c9d6c6c1f5f16a3f069ce0722efc1d6e078bbbd4)) +* add cadd-rest-api support via docker-compose.override.yml ([#48](https://github.com/varfish-org/varfish-docker-compose/issues/48)) ([c9d6c6c](https://github.com/varfish-org/varfish-docker-compose/commit/c9d6c6c1f5f16a3f069ce0722efc1d6e078bbbd4)) -* adding ClinVar download instructions to README ([#28](https://github.com/varfish-org/varfish-docker-compose/issues/28)) ([d4ead82](https://github.com/varfish-org/varfish-docker-compose/commit/d4ead82594a74544a50c59850ac60ee78f043d57)) +* add ClinVar download instructions to README ([#28](https://github.com/varfish-org/varfish-docker-compose/issues/28)) ([d4ead82](https://github.com/varfish-org/varfish-docker-compose/commit/d4ead82594a74544a50c59850ac60ee78f043d57)) -* adding download-data.sh script ([#42](https://github.com/varfish-org/varfish-docker-compose/issues/42)) ([1f6fca8](https://github.com/varfish-org/varfish-docker-compose/commit/1f6fca8287b9d0c43fb8ab3716dd4cdd99a378db)) +* add download-data.sh script ([#42](https://github.com/varfish-org/varfish-docker-compose/issues/42)) ([1f6fca8](https://github.com/varfish-org/varfish-docker-compose/commit/1f6fca8287b9d0c43fb8ab3716dd4cdd99a378db)) -* adding dynamic varfish data directory ([#87](https://github.com/varfish-org/varfish-docker-compose/issues/87)) ([fd96c82](https://github.com/varfish-org/varfish-docker-compose/commit/fd96c828bf1c4a34c3ce3c7f0005a9b829065380)) +* add dynamic varfish data directory ([#87](https://github.com/varfish-org/varfish-docker-compose/issues/87)) ([fd96c82](https://github.com/varfish-org/varfish-docker-compose/commit/fd96c828bf1c4a34c3ce3c7f0005a9b829065380))
25-27
: Use imperative mood in Bug Fixes bullets.Align with Conventional Commits tone.
Apply this diff:
-* adding clinvar links for mehari ([#83](https://github.com/varfish-org/varfish-docker-compose/issues/83)) ([dbb254a](https://github.com/varfish-org/varfish-docker-compose/commit/dbb254acee1ad6e51b6843abc18b1135159c9542)) +* add ClinVar links for Mehari ([#83](https://github.com/varfish-org/varfish-docker-compose/issues/83)) ([dbb254a](https://github.com/varfish-org/varfish-docker-compose/commit/dbb254acee1ad6e51b6843abc18b1135159c9542)) -* adding hgnc_xlink.tsv for viguno ([#79](https://github.com/varfish-org/varfish-docker-compose/issues/79)) ([6929e71](https://github.com/varfish-org/varfish-docker-compose/commit/6929e717f78a774397f873c9a5af82fe3a770e9d)) +* add hgnc_xlink.tsv for Viguno ([#79](https://github.com/varfish-org/varfish-docker-compose/issues/79)) ([6929e71](https://github.com/varfish-org/varfish-docker-compose/commit/6929e717f78a774397f873c9a5af82fe3a770e9d)) -* adding s3:GetBucketLocation to minio policy ([#30](https://github.com/varfish-org/varfish-docker-compose/issues/30)) ([9e94ad0](https://github.com/varfish-org/varfish-docker-compose/commit/9e94ad09a9ed6410105b23d2f760fbc48c29ebf6)) +* add s3:GetBucketLocation to MinIO policy ([#30](https://github.com/varfish-org/varfish-docker-compose/issues/30)) ([9e94ad0](https://github.com/varfish-org/varfish-docker-compose/commit/9e94ad09a9ed6410105b23d2f760fbc48c29ebf6))
18-19
: Tense/style consistency on “bumping”.Prefer “bump …” over “bumping …” for consistency with other bullets.
Apply this diff:
-* bumping annonars, clinvar data, adding clinvar-genes ([#29](https://github.com/varfish-org/varfish-docker-compose/issues/29)) ([fbdcaf1](https://github.com/varfish-org/varfish-docker-compose/commit/fbdcaf15bf255a0ed94edac50e1a62529631b752)) +* bump annonars, clinvar data; add clinvar-genes ([#29](https://github.com/varfish-org/varfish-docker-compose/issues/29)) ([fbdcaf1](https://github.com/varfish-org/varfish-docker-compose/commit/fbdcaf15bf255a0ed94edac50e1a62529631b752)) -* bump downloader to be on par with reev one ([#57](https://github.com/varfish-org/varfish-docker-compose/issues/57)) ([a8c02e3](https://github.com/varfish-org/varfish-docker-compose/commit/a8c02e3ed2e3309dc3b839b40e45c017aafa04b5)) +* bump downloader to be on par with Reev one ([#57](https://github.com/varfish-org/varfish-docker-compose/issues/57)) ([a8c02e3](https://github.com/varfish-org/varfish-docker-compose/commit/a8c02e3ed2e3309dc3b839b40e45c017aafa04b5))
44-44
: Grammar/casing nit.“using bitnami minio clients to startup works again” reads a bit awkward and casing is off. Suggest: “use Bitnami MinIO client; startup works again” or “restore startup by using the Bitnami MinIO client.”
Apply this diff:
-* using bitnami minio clients to startup works again ([#36](https://github.com/varfish-org/varfish-docker-compose/issues/36)) ([7e199f3](https://github.com/varfish-org/varfish-docker-compose/commit/7e199f373d57ef9d97c38e1367a63fbac95c876b)) +* restore startup by using the Bitnami MinIO client ([#36](https://github.com/varfish-org/varfish-docker-compose/issues/36)) ([7e199f3](https://github.com/varfish-org/varfish-docker-compose/commit/7e199f373d57ef9d97c38e1367a63fbac95c876b))
1-1
: Optional: add “Unreleased” section scaffold (Keep a Changelog style).Not required for release-please, but if you follow Keep a Changelog, consider adding an “Unreleased” section above 1.0.0 for future entries.
Happy to push a minimal PR to add the scaffold if you want.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
CHANGELOG.md
(1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)
3-6
: Release entry looks solid.Clear 1.0.0 section with date (2025-08-26) and standard subsections. Links and SHAs included; format matches release-please output.
🤖 I have created a release beep boop
1.0.0 (2025-08-26)
Features
Bug Fixes
This PR was generated with Release Please. See documentation.
Summary by CodeRabbit