open-feature / open-feature/protocol
Configure Release Please
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 56
- Forks
- 7
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
Overview
Release Please is used throughout OpenFeature to help automate the release process in a consistent way. We should include it in the protocol repo as well to automatically bump the OpenAPI version when a relevant change is made.
Steps
- Update the repo config to only allow squash merges
- Add a GitHub workflow that validates PR titles
- Add Release Please and configure it to watch openapi.yaml (hopefully watching a single file is possible)
- Update the openapi.yaml file with a comment that bumps the schema version
- Cut a new release
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 configuration and service/openapi.yaml named in the issue. Add the PR-title validation workflow and configure Release Please to watch the OpenAPI schema, then update the schema version comment and cut a release. Done means squash-only merges, validation, automated version bumping, and a new release are all configured.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, openapi
- Domain
- api, ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100