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.

Sign up for GitHub

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

Jump to bottom

Update developer release guidelines #21

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Update developer release guidelines #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Points to note:

### Development workflow

Changes are merged to the repository as follows:
Changes are committed to the repository as follows:

1. Create a new feature branch from the current `develop` branch, named with the relevant prefix:
- `feature/...` - Branch contains new features
Expand All @@ -76,14 +76,10 @@ When the contents of the `develop` branch are ready to be released, follow these
```
2. Raise a new PR that merges `develop` into `main`
3. Wait for CI tests to pass
4. Merge the PR using the 'rebase' merge stragegy
4. Merge the PR using the 'merge commit' merge stragegy

This will cause CI to perform the following actions:

- Build and publish all public packages
- Tag the repository with the current package version
- Create a Github 'Release' page linked to the release commit

Once the release has succeeded, rebase the `develop` branch onto the `main` branch and force-push to retain linear commit history.

> This step is only necessary because Github does not yet allow fast-forward merges: https://github.com/orgs/community/discussions/4618 (see workarounds)
Loading