doc: update changelog with breaking change information from commit footer #625
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There is no change in the changelog. This PR will not produce a new releasable version. |
Taepper
force-pushed
the
better-030-changelog
branch
from
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.
Do we provide the script?
There was a problem hiding this comment.
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.
Suggested change
| * The preprocessing config field pangoLineageDefinitionFilename has been renamed to lineageDefinitionFilename. | |
| * The preprocessing config field `pangoLineageDefinitionFilename` has been renamed to `lineageDefinitionFilename`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.