diff --git a/bin/release b/bin/release index 4b5c0f8f..807fe410 100755 --- a/bin/release +++ b/bin/release @@ -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." \ No newline at end of file diff --git a/docs/releasing.md b/docs/releasing.md new file mode 100644 index 00000000..0a7fec7d --- /dev/null +++ b/docs/releasing.md @@ -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 ` +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.