Skip to content

Commit

Permalink
Document how to use the github release automations for releases
Browse files Browse the repository at this point in the history
  • Loading branch information
anjannath authored and praveenkumar committed May 17, 2023
1 parent 1604323 commit e915b6a
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions developing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,45 @@ $ CRC_DEBUG_ENABLE_STOP_NTP=true crc start
=== Logs

Test logs can be found in [filename]`test/e2e/out/test-results`.


[[making-github-release]]
== Releasing on Github

=== Releasing using the github actions workflow

The github actions workflow link:https://github.com/crc-org/crc/actions/workflows/release.yml[`Publish release on github`] creates a draft release and provides a template with all the component versions and the git change log.

To start the workflow go to the link:https://github.com/crc-org/crc/actions/workflows/release.yml[workflow page] and click on the `Run Workflow` button, make sure to choose the appropriate tag for the release.

Once the draft release is available, edit it to include the notable changes for the release and press publish to make it public.

=== Releasing using the `gh-release.sh` script

In the CRC repository, we have a script link:https://github.com/crc-org/crc/blob/main/gh-release.sh[`gh-release.sh`] which uses the link:https://cli.github.com[`gh`] tool, make sure it is installed.

Create a markdown file containing a list of the notable changes named `notable_changes.txt` in the same directory as the script.

An example `notable_changes.txt`:

[source,bash]
----
$ cat notable_changes.txt
- Fixes a bug where `oc` binary was not extracted from bundle when using microshift preset [#3581](https://github.com/crc-org/crc/issues/3581)
- Adds 'microshift' as a possible value to the help string of the 'preset' confg option [#3576](https://github.com/crc-org/crc/issues/3576)
----

Then run the script from the release tag and follow the prompts, it'll ask for confirmation before pushing the draft release to github.

[NOTE]
====
The script will exit with error if it doesn't find a tag starting with `v` in the current git HEAD.
====

[source,bash]
----
$ git checkout v2.18.0
$ ./gh-release.sh
----

Verify the draft release on the releases page and if everything looks good press publish to make the release public.

0 comments on commit e915b6a

Please sign in to comment.