Merged
Conversation
added 5 commits
August 26, 2025 20:50
As it seems we fixed the issue on release going through as expected, we clean up the workflow
We are also removing the old `how_to_contribute.md` in favor of the new `CONTRIBUTING.md`
- We update the settings of `semantic-release` to output the changelog in the `/docs` directory. - We also add a link from the top-level `index.md` of the docs to reference the CHANGELOG.md - We remove the CHANGELOG generated in the previous auto-releave because the version number was wrong.
To update the version in the `pyproject.toml`. Adding the command to install the plugin in the workflow.
From v0.1.0-development to v0.2.0-development allowed to leverage the field `[project].version` in the `pyproject.toml` instead of the code looking for the poetry quivalent.
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
1 participant
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.
Adapting the configuration of
semantic-releaseto accomodate a prefered location of the CHANGELOG in the/docs. Also made changes to update the version number in thepyproject.tomlautomatically.Dependency Management:
pyproject.toml automaticallyDocumentation Refactoring & Reference Updates:
CONTRIBUTING.mdand related contribution guides from the root to thedocsdirectory, updating all references inREADME.md,docs/index.md, and internal documentation to point to the new locations. [1] [2] [3] [4]docs/articles/devs/how_to_contribute.mdfile, consolidating contribution guidelines underdocs/CONTRIBUTING.md.docs/index.mdfor easier access to release history.Release Automation & Changelog Management:
.releaserc.jsonto generate and store changelogs indocs/CHANGELOG.mdinstead of the project root, and include this file as a release asset.@covage/semantic-release-poetry-plugin) into semantic-release configuration for automated Python package versioning. [1] [2]CHANGELOG.mdfrom the root directory, aligning with the new changelog location.Minor Workflow Cleanup:
run-nameproperty from the semantic-release GitHub Actions workflow for clarity.