tektronix / tektronix/python-package-ci-cd
[FEAT]: Update `python-semantic-release` usage (including templates) to take advantage of enhancements added in `python-semantic-release==9.10.0`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 1
- Avg merge
- 15h 7m
- Merged PRs (30d)
- 27
Description
Description
python-semantic-release version 9.10.0 added a lot of new features to make changelog updates simpler. This should allow simplifying the actions/workflows in this repository to no longer need to copy over the previous changelog file contents.
Additional Information
See the information on the https://python-semantic-release.readthedocs.io/en/stable/concepts/changelog_templates.html page about customizing the changelog and the available variables/filters for the template.
This change would probably necessitate a v2 release, since it would break backwards compatibility in the find_unreleased_changelog_items action.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository's actions and reusable workflows, then read actions/find_unreleased_changelog_items/readme.md alongside the python-semantic-release changelog template documentation. Identify where previous changelog contents are copied and how the available template variables can replace that logic. Done means the workflows are simplified and the compatibility impact, including a possible v2 release, is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100