Skip to content

chore: add details on how to follow the release process #1682

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

Open
zacharyjhankin wants to merge 5 commits into
base: develop
Choose a base branch
from
+4 −0
Open

chore: add details on how to follow the release process #1682

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2db0b40
add docs on release process
zacharyjhankin Jul 27, 2026
b0a7e73
fix capital
zacharyjhankin Jul 27, 2026
59a5c86
fix grammar
zacharyjhankin Jul 27, 2026
ae1343f
Merge branch 'develop' into add-release-docs
jekabs-karklins Jul 28, 2026
b7a2d3d
Merge branch 'develop' into add-release-docs
jekabs-karklins Jul 29, 2026
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
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Please consider these guidelines when filing a pull request:

## Creating releases

To create a release, you must create a pull request from the develop branch into 'master' using the 'Rebase and merge' option. Once this has been approved it will automatically run the pipeline to generate a new release. [example](https://github.com/UserOfficeProject/user-office-core/pull/1621)

@joeshannon joeshannon Jul 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Are we sure about the 'Rebase and merge' option?
I would have thought it would be a normal merge. For example if there were hotfixes on master between releases this option would 'duplicate' the commits from develop by reapplying them on top of master?


After this, create a new pull request merging 'master' into 'develop' using the 'Rebase and merge' option. There should be no files changed, but the commits listed. This is to ensure the branches remain in sync. [example](https://github.com/UserOfficeProject/user-office-core/pull/1623)

UserOfficeProject/user-office-core uses [semantic-release](https://github.com/semantic-release/semantic-release)
to release new versions automatically.

Expand Down
Loading