-
Notifications
You must be signed in to change notification settings - Fork 3
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
doc: update changelog with breaking change information from commit footer #625
base: main
Are you sure you want to change the base?
Conversation
There is no change in the changelog. This PR will not produce a new releasable version. |
81bd464
to
a213623
Compare
@@ -6,6 +6,11 @@ | |||
### ⚠ BREAKING CHANGES | |||
|
|||
* generalized wildcard queries ([#458](https://github.com/GenSpectrum/LAPIS-SILO/issues/458)) | |||
* The preprocessing config field pangoLineageDefinitionFilename has been renamed to lineageDefinitionFilename. | |||
* We now accept a YAML lineage definition file instead of a Pango alias key. A script (scripts/alias2lineageDefinitions.py) is provided to transform a list of lineages and an alias into the required file format. |
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.
Do we provide the script?
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.
Ah, right. That slipped my attention
@@ -6,6 +6,11 @@ | |||
### ⚠ BREAKING CHANGES | |||
|
|||
* generalized wildcard queries ([#458](https://github.com/GenSpectrum/LAPIS-SILO/issues/458)) | |||
* The preprocessing config field pangoLineageDefinitionFilename has been renamed to lineageDefinitionFilename. |
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.
* The preprocessing config field pangoLineageDefinitionFilename has been renamed to lineageDefinitionFilename. | |
* The preprocessing config field `pangoLineageDefinitionFilename` has been renamed to `lineageDefinitionFilename`. |
Summary
I unfortunately did not do a good job of adding the commit information from the footer in a correct way, such that it will be displayed in the changelog. I now add this manually and improved to the changelog
PR Checklist
- [ ] All necessary documentation has been adapted or there is an issue to do so.- [ ] The implemented feature is covered by an appropriate test.