Skip to content

Update RELEASING.md #2990

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

Merged
merged 2 commits into from
Jun 4, 2024
Merged

Update RELEASING.md #2990

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d7b312
Update RELEASING.md
GromNaN May 31, 2024
21bfc7b
Import release process from PHPC
GromNaN Jun 4, 2024
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
16 changes: 5 additions & 11 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,18 @@ Update the version's release date and status from the
[Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPORM/versions)
page.

## Update version info
## Choose a version

This uses [semantic versioning](https://semver.org/). Do not break
backwards compatibility in a non-major release or your users will kill you.

Before proceeding, ensure that the default branch is up-to-date with all code
changes in this maintenance branch. This is important because we will later
merge the ensuing release commits with `--strategy=ours`, which will ignore
changes from the merged commits.
## Create the release with GitHub Action

## Tag the release
Go to the [Release New Version](https://github.com/mongodb/laravel-mongodb/actions/workflows/release.yml) action an click on "Run workflow".

Create a tag for the release and push:
Select the branch to release, the new version number and click "Run workflow".

```console
$ git tag -a -m "Release X.Y.Z" X.Y.Z
$ git push mongodb --tags
```
The GitHub Action will create the tag and a draft release. Update and publish the release.

## Branch management

Expand Down