Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to include point release instructions #536

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

seadanda
Copy link
Contributor

Also update project structure while I'm here

  • Does not require a CHANGELOG entry

@@ -61,6 +68,18 @@ The release process is building all runtimes and then puts them into a release i

The format of [`CHANGELOG.md`](CHANGELOG.md) is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Point releases

In order to release a patch or fix outside the normal release process, some additional steps are needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not ultra happy with this process, but until someone has automated it, it is good to have it written down.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally there would be a bot command so you could call /cmd point-release or whatever in a comment on a PR made against the x.y.z branch, the bot would create branch x.y.b, rebase the PR to x.y.b then trigger the release process from release-* branch when it sees the usual changelog changes when the branch is merged.

Probably would need to know which release is on chain and only allow +1s to avoid lots of branches being made.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
seadanda and others added 2 commits January 10, 2025 14:05
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
Co-authored-by: Sebastian Kunert <[email protected]>
@bkchr
Copy link
Contributor

bkchr commented Jan 10, 2025

/merge

@fellowship-merge-bot fellowship-merge-bot bot enabled auto-merge (squash) January 10, 2025 18:20
@fellowship-merge-bot
Copy link
Contributor

Enabled auto-merge in Pull Request

Available commands
  • /merge: Enables auto-merge for Pull Request
  • /merge cancel: Cancels auto-merge for Pull Request
  • /merge help: Shows this menu

For more information see the documentation

@fellowship-merge-bot
Copy link
Contributor

Failed to update PR ❌

There was an error while trying to keep this PR up-to-date

You may have conflicts ‼️ or may have to manually sync it with the target branch 👉❇️

More info in the logs 📋

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants