mitodl / mitodl/release-script
Extract Doof release notes generation into an individual CLI script
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 16
- Forks
- 8
- Avg merge
- 11h 47m
- Merged PRs (30d)
- 2
Description
Edit: we should probably consider https://changelogd.readthedocs.io/en/latest/ instead of maintaining our own tool
Doof has code that currently generates release notes based on a diff of changes since the last version. We should extract this into a tool that can be run on the CLI and output to stdout.
Contributor guide
No contributing guide indexed for this repository
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 by locating Doof’s existing release-notes generation code and understanding how it computes changes since the last version. Decide whether the standalone CLI should be implemented or changelogd used, then verify that the chosen tool can run from the command line and write the generated notes to stdout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, release, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100