Skip to content

Conversation

varfish-bot
Copy link

@varfish-bot varfish-bot commented Jun 4, 2024

🤖 I have created a release beep boop

1.0.0 (2025-08-26)

Features

  • add gnomAD SV/CNV 4.0 for GRCh38 (#55) (48ba90d)
  • add MinIO server for file storage purposes (#2) (#7) (34b37c4)
  • add traefik service with configuration examples (#3) (#5) (8cfbc21)
  • adding cadd-rest-api support via docker-compose.override.yml (#48) (c9d6c6c)
  • adding ClinVar download instructions to README (#28) (d4ead82)
  • adding download-data.sh script (#42) (1f6fca8)
  • adding dynamic varfish data directory (#87) (fd96c82)
  • adding nginx for serving track data (#15) (#20) (973b640)
  • adding templates for exomiser integration (#46) (dea2c78)
  • bump annonars/genes (#58) (d3cf847)
  • bump downloader to be on par with reev one (#57) (a8c02e3)
  • bumping annonars, clinvar data, adding clinvar-genes (#29) (fbdcaf1)
  • splitting download into more steps (#75) (a6c4737)

Bug Fixes

  • adding clinvar links for mehari (#83) (dbb254a)
  • adding hgnc_xlink.tsv for viguno (#79) (6929e71)
  • adding s3:GetBucketLocation to minio policy (#30) (9e94ad0)
  • adding segdup besides old seqdup (#84) (18ad21d)
  • adding viguno env setup (c5c759a)
  • adjust downloads for worker and mehari (#80) (0f479c5)
  • allow graceful shutdown of minio-client container (#21) (575c07e)
  • bump mehari-data-tx to 0.6.0 (#59) (3ffacf9)
  • bump version in annonars genes (8ab9538)
  • docker-compose.override.yml file for certificate (#72) (a076d3f)
  • docker-compose.override.yml for cadd-rest-api (#73) (ce3a7df)
  • Fix download script variable names (#61) (73d88db)
  • mehari freqs path (#70) (6fb8dcb)
  • putting BOT_TOKEN into release-please GitHub actions workflow (#68) (049d3df)
  • remove version specification from docker-compose (#96) (d2c69e8)
  • seqdup => segdup (083c66f)
  • typo mime2gene (#85) (70e3854)
  • update readme (#41) (7b53228)
  • updating cadd-rest-api.env example file (#50) (81eeb8a)
  • using bitnami minio clients to startup works again (#36) (7e199f3)
  • various version changes (#82) (fd050b9)

This PR was generated with Release Please. See documentation.

Summary by CodeRabbit

  • New Features
    • Introduces gnomAD SV/CNV 4.0 (GRCh38), MinIO-backed storage, Traefik with config examples, cadd-rest-api via override, dynamic data directory, Nginx for track serving, Exomiser templates, granular download steps, and a new download script.
  • Bug Fixes
    • Adds missing permissions, environment/setup tweaks, graceful shutdowns, path and variable fixes, rename/typo corrections, override entries for certificates and services, and multiple version updates.
  • Documentation
    • Adds ClinVar download instructions and updates README/env examples; includes a 1.0.0 changelog entry.
  • Chores
    • Version bumps and downstream compatibility notes.

@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from f42c135 to 8c57962 Compare June 4, 2024 11:37
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch 3 times, most recently from e0a7e5e to 96f8abf Compare June 10, 2024 13:04
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch 2 times, most recently from d6e6d70 to 25cb921 Compare June 18, 2024 11:45
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from 25cb921 to 9086777 Compare July 11, 2024 12:56
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch 5 times, most recently from 58b18c7 to 3b588fa Compare September 3, 2024 10:17
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from 3b588fa to 6ff58c9 Compare October 7, 2024 12:13
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from 6ff58c9 to ba9666e Compare October 23, 2024 09:24
Copy link

coderabbitai bot commented Oct 23, 2024

Walkthrough

Adds 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

Cohort / File(s) Change Summary
Changelog
CHANGELOG.md
Added new release entry for 1.0.0 dated 2025-08-26 with full features and bug-fix list; trailing artifact header present.
Compose & env overrides
docker-compose.override.yml, cadd-rest-api.env, docker-compose.yml*
Added/updated entries for cadd-rest-api, certificates, removed a docker-compose version constraint, and adjusted env examples.
Storage & services
minio/* (configs), traefik/* (configs), nginx/* (configs)
Introduced MinIO server config and policy changes (s3:GetBucketLocation), Traefik service/config examples, and Nginx for serving track data.
Download & data scripts
download-data.sh, downloaders/*, mehari/*
Added download-data.sh, split download steps, fixed variable names, updated Mehari frequencies path, graceful shutdown for minio-client, and other download adjustments.
Data sources & integration
README.md, README* additions, exomiser/* templates, clinvar/* instructions
Added ClinVar download instructions, Exomiser templates, ClinVar links for Mehari, and README updates including cadd-rest-api usage.
Data/version bumps
mehari-data-tx (bumped to 0.6.0), annonars/genes, downloader, other versioned components
Bumped multiple component versions and noted downstream/bump compatibility.
Viguno & supporting files
viguno/hgnc_xlink.tsv, viguno/* env/setup
Added hgnc_xlink.tsv, Viguno environment setup, and related fixes (mime2gene typo).
Bugfixes & minor renames
Various files across repo (seqdupsegdup, permission fixes, typo fixes)
Renamed seqdup to segdup, added segdup alongside seqdup references, fixed typos, and adjusted permissions and startup client behavior (Bitnami MinIO clients).

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
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

In burrows of bytes I hop with glee,
MinIO stashes seeds for me.
Traefik guides the morning light,
Downloads hum through day and night.
A rabbit cheers: versions shine — release, hooray! 🐇✨

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release-please--branches--main

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Files that changed from the base of the PR and between 8ab9538 and ba9666e.

📒 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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

Suggested change
## Changelog

@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from ba9666e to a8c34fd Compare October 30, 2024 09:14
@varfish-bot varfish-bot force-pushed the release-please--branches--main branch from a8c34fd to 0f6f29d Compare August 26, 2025 12:41
Copy link

@coderabbitai coderabbitai bot left a 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 =&gt; 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.

📥 Commits

Reviewing files that changed from the base of the PR and between a8c34fd and 0f6f29d.

📒 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant