project-akri / project-akri/examples
Switch from version.txt to release-please for automated releases
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 0
- Forks
- 1
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 2
Description
Context
Currently, versioning is managed manually via version.txt, which both container build workflows use to tag images. This approach requires manual bumps and has resulted in no published GitHub releases so far.
As Akri components move to independent repositories, each repo should manage its own release lifecycle. release-please is the right tool for this — it automates version bumps, changelog generation, and GitHub release creation based on conventional commits.
Work involved
- Remove
version.txt - Add
release-pleaseworkflow and config - Update GitHub workflows to read version from the GitHub release tag instead of
version.txt - Adopt conventional commits going forward
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 version.txt and the two container build workflows that currently use it for image tags. Then review the release-please workflow and configuration requirements, including conventional commits. Done means version.txt is removed, releases and changelogs are generated, and both workflows obtain their image version from the GitHub release tag.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100