diff --git a/docs/build-and-release.md b/docs/build-and-release.md index 314f7bff..aeb4dd09 100644 --- a/docs/build-and-release.md +++ b/docs/build-and-release.md @@ -20,9 +20,9 @@ Travis CI builds differ by branch: > - alfresco/alfresco-libreoffice > - alfresco/alfresco-transform-misc > - alfresco/alfresco-transform-core-aio - - if the commit message contains the `[trigger release]` tag, the builds will also + - if the commit message contains the `[release]` tag, the builds will also include the _Release_ stage; - - PR builds where the latest commit contains the `[trigger release]` tag will execute dry runs + - PR builds where the latest commit contains the `[release]` tag will execute dry runs of the release jobs (no artifacts will be published until the PR is actually merged). * `ATS-*` / `ACS-*` branches: - regular builds which include only the _Build_ and _Tests_ stages; @@ -45,20 +45,20 @@ maven command, i.e. ``` 3. Update the project's dependencies (remove the `-SNAPSHOT` suffixes - only for dependencies, not for the local project version). -4. Create a new commit with the `[trigger release]` tag in its message. If no local changes have +4. Create a new commit with the `[release]` tag in its message. If no local changes have been generated by steps (2) and (3), then an empty commit should be created - e.g. ```bash - git commit --allow-empty -m "ATS-###: Release T-Core (T-Engines) #.##.# [trigger release]" + git commit --allow-empty -m "ATS-###: Release T-Core (T-Engines) #.##.# [release]" ``` - > The location of the `[trigger release]` tag in the commit message is irrelevant. + > The location of the `[release]` tag in the commit message is irrelevant. - > If for any reason your PR contains multiple commits, the commit with the `[trigger release]` + > If for any reason your PR contains multiple commits, the commit with the `[release]` tag should be the last (newest) one. This will trigger the Release dry runs. 5. Open a new Pull Request from the `ATS-###_release_version` branch into the original `master` / `SP/*` / `HF/*` branch and wait for a green build; the **Release** stage on the PR build will only execute a _Dry_Run_ of the release. 6. Once it is approved, merge the PR, preferably through the **Rebase and merge** option. If the **Create a merge commit** (_Merge pull request_) or **Squash and merge** options are used, you -need to ensure that the _commit message_ contains the `[trigger release]` tag (sub-string). +need to ensure that the _commit message_ contains the `[release]` tag (sub-string).