Skip to content

Commit

Permalink
Add release documentation (#137)
Browse files Browse the repository at this point in the history
* Add release documentation

* tweak
  • Loading branch information
mhsdef authored Oct 1, 2024
1 parent 3ac0160 commit 5f32d9f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
5 changes: 4 additions & 1 deletion bin/release
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,11 @@ echo "Updated $php_file from $current_version to $new_version"

echo "Version bump complete: $new_version"

# Create a new branch for the release
git checkout -b release/v"$new_version"

# Commit the changes
git add "$php_file"
git commit -m "v$new_version"

echo "Changes committed to the current branch"
echo "Changes committed to release/v$new_version branch. Push the branch to the remote repository and create a pull request."
14 changes: 14 additions & 0 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Releasing

## Versioning

Remote Data Blocks uses [Semantic Versioning](https://semver.org/).

## Release process

1. Checkout the `trunk` branch and ensure it is up to date.
2. Run the release script: `./bin/release <major|minor|patch>`
3. Push the new release branch to the remote repository and create a pull request.
4. Merge the pull request into `trunk`.

The release process from there is automated using GitHub Actions and will publish a new release on GitHub if the version has changed.

0 comments on commit 5f32d9f

Please sign in to comment.