feat: Add Zenodo changelog#789
Merged
Merged
Conversation
…ase process - Add CHANGELOG.md to scripts/resources, bundled into every generated archive so each downloaded version carries its own history; documents versions 1–4 (pre-changelog) and v5 in detail - Update export script to include CHANGELOG.md alongside the README and license in the zip output - Add a release-procedure note to the module docstring pointing maintainers to the changelog and deployment docs before each Zenodo publish
Coverage Report for CI Build 29037658105Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Warning No base build found for commit Coverage: 88.967%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats
💛 - Coveralls |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request adds a versioned changelog to the MaveDB public data dump archive and includes it in the exported data bundle. It also updates documentation to clarify the release process and the new file layout. The most important changes are:
Changelog integration and release process:
CHANGELOG.mdfile insrc/mavedb/scripts/resources/that documents changes between versions of the MaveDB public data archive published on Zenodo, starting with version 5. This changelog is now bundled inside every archive.export_public_data.pyto includeCHANGELOG.mdin the exported archive and updated the release instructions to require a changelog entry for every new version. [1] [2]Documentation and file layout:
README.mdin the archive to listCHANGELOG.mdas part of the archive file structure.