Repository navigation
Add a CHANGELOG, automate PyPI publishing, and prepare v1.4 - #34
Merged
Merged
Conversation
The 1.3.0 artifact on PyPI was built from a working-tree config that was never committed, so the committed file could not reproduce it. This commit adopts that configuration. Two metadata fields were wrong in v1.3. license pointed at a LICENSE file the repository did not carry until May 2026, and is now the SPDX expression MIT with license-files. The project URLs pointed at NHERI-SimCenter, which has no such repository, and now point at OpenPBEE. requirements.txt is redundant with the pyproject dependencies and is removed.
Each release opens with a Methodology section covering changes to the simulation method itself or core data, kept separate from bug fixes and tooling. Changes under Methodology alter results by design and users need to see them first. The preamble states the versioning policy in place of a semantic versioning claim: the number follows the ATC-138 methodology lineage from the MATLAB codebase, so a minor release can change results.
Publishing a GitHub Release now uploads that version to PyPI through Trusted Publishing, so a collaborator cutting a release needs no separate tag push and no local build. The build job refuses to continue when the release tag and the version in pyproject.toml disagree, which catches a release cut against a forgotten version bump. Only the published event is subscribed to, since PyPI uploads are immutable and editing a release afterward must not trigger a second upload.
cff-version was 1.0.0, which predates the schema the file is written against, and both DOI fields carried a URL where the schema expects a bare DOI. The software DOI now points at the Zenodo concept DOI, which resolves to the current version and needs no edit each release.
more concisely state the change and provide context that this project only contains FR specific attributes rather than the entire fragilities
dustin-cook
approved these changes
Sep 10, 2026
dustin-cook
left a comment
dustin-cook
left a comment
Collaborator
There was a problem hiding this comment.
Looks good. I added some minor updates to the change log.
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.
Prepares the v1.4 release. Four self-contained commits; the commit messages carry the detail.
build:commits the packaging configuration that actually produced the 1.3.0 wheel on PyPI. Also corrects the license metadata and the project URLs, and dropsrequirements.txtas redundant withpyproject.toml.docs:addsCHANGELOG.md, covering v1.4 and v1.3.ci:uploads to PyPI when a GitHub Release is published, through Trusted Publishing with a gatedpypienvironment. No stored token.chore(release):fixes the CFF schema version and DOI format, and points the software DOI at the Zenodo concept DOI so citations stay current across releases.