|
3 | 3 | To create a release follow the below steps |
4 | 4 |
|
5 | 5 | ## Release preparation |
6 | | - - Create a **draft** of Release from the `main` branch using [github releases page](https://github.com/utPLSQL/utPLSQL/releases) and populate release description using information found on the issues and pull requests **since previous release**. |
| 6 | + - Create a **draft** of a Release with version number `vX.Y.X` sourced from the `main` branch using [github releases page](https://github.com/utPLSQL/utPLSQL/releases) and populate release description using information found on the issues and pull requests **since previous release**. |
7 | 7 | To find issues closed after certain date use [advanced filters](https://help.github.com/articles/searching-issues-and-pull-requests/#search-by-open-or-closed-state). |
8 | 8 | Example: [`is:issue closed:>2018-07-22`](https://github.com/utPLSQL/utPLSQL/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%3E2018-07-22+) |
9 | 9 |
|
10 | 10 | ## Performing a release |
11 | 11 | - create the release branch from `develop` branch and make sure to name the release branch: `release/vX.Y.Z` |
12 | 12 | - update, commit and push at least one file change in the release branch, to kick off a build on [GithubActions](https://github.com/utPLSQL/utPLSQL/actions) or kick-off a build manually for that branch after it was created on github. |
13 | 13 | - wait for the build to complete successfully as it will update the version to be release number (without develop) |
14 | | - - merge the release branch to `main` branch and wait for build on `main` branch to complete successfully (do not use Squash/rebase for merge operation) |
15 | | - - Publish the release on the `main` branch and tag it with version number `vX.Y.Z` |
16 | | - - Wait for the release build to finish successfully on Github Actions as this will upload release artifacts (`zip` and `tar.gz` files along with `md5`) |
17 | | - - After A Release build was completed successfully, merge main branch back into develop branch. |
18 | | - - At this point, main branch and release tag should be at the same commit version and artifacts should be uploaded into Github release. |
| 14 | + - merge the release branch to `main` branch and publish [the previously prepared](#release-preparation) release draft. |
| 15 | + - Wait for the [Github Actions `Release`](https://github.com/utPLSQL/utPLSQL/actions/workflows/release.yml) process to complete successfully. The process will upload release artifacts (`zip` and `tar.gz` files along with `md5`) |
| 16 | + - After Release build was completed successfully, merge the `main` branch back into `develop` branch. At this point, main branch and release tag should be at the same commit version and artifacts should be uploaded into Github release. |
19 | 17 | - After develop branch was built, increase the version number in `VERSION` file to represent next planned release version. |
20 | | - - Clone `utplsql.githug.io` project and add a new announcement about next version being released in `_posts`. Use previous announcements as a template. Make sure to set date, time and post title properly. |
| 18 | + - Clone `utplsql.githug.io` project and: |
| 19 | + - Add a new announcement about next version being released in `docs/_posts`. Use previous announcements as a template. Make sure to set date, time and post title properly. |
| 20 | + - Add the post to list in `mkdocs.yml` file in root directory of that repository. |
| 21 | + - Add the link to the post at the beginning of the `docs/index.md` file. |
21 | 22 |
|
22 | 23 | The following will happen: |
23 | 24 | - build executed on branch `release/vX.Y.Z-[something]` updates files `sonar-project.properties`, `VERSION` with project version derived from the release branch name |
|
0 commit comments