-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
107 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| Releasing on GitHub | ||
| =================== | ||
|
|
||
|
|
||
| ## Releasing using the github actions workflow | ||
|
|
||
| The GitHub Actions workflow [`Publish release on github`](https://github.com/crc-org/crc/actions/workflows/release.yml) 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 [workflow page](https://github.com/crc-org/crc/actions/workflows/release.yml) 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 [`gh-release.sh`](https://github.com/crc-org/crc/blob/main/gh-release.sh) which uses the [`gh`](https://cli.github.com) 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`: | ||
| ```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' config 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. | ||
| ```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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| Testing | ||
| ======= | ||
|
|
||
|
|
||
| ## Running e2e tests | ||
|
|
||
| We have automated e2e tests which ensure the quality of our deliverable; CRC, and system bundle. | ||
|
|
||
|
|
||
| ### Introduction | ||
|
|
||
| End-to-end (e2e) tests borrow code from [Clicumber](http://github.com/crc-org/clicumber) package to provide basic functionality for testing CLI binaries. This facilitates running commands in a persistent shell instance (`bash`, `tcsh`, `zsh`, Command Prompt, or PowerShell), assert its outputs (standard output, standard error, or exit code), check configuration files, and so on. The general functionality of Clicumber is then extended by CRC specific test code to cover the whole functionality of CRC. | ||
|
|
||
| ### How to run | ||
|
|
||
| First, one needs to set the following flags in `Makefile`, under `e2e` target: | ||
|
|
||
| - `--pull-secret-file` | ||
| absolute path to your OpenShift pull secret. | ||
| - `--bundle-location` | ||
| if bundle is embedded, this flag should be set to `--bundle-location=embedded` or not passed at all | ||
| if bundle is not embedded, then absolute path to the bundle should be passed | ||
| - `--crc-binary` | ||
| if `crc` binary resides in `$GOPATH/bin`, then this flag does not need to be passed | ||
| otherwise absolute path to the `crc` binary should be passed. | ||
|
|
||
| To start e2e tests, run: | ||
|
|
||
| ```bash | ||
| $ make e2e | ||
| ``` | ||
|
|
||
| #### How to run only a subset of all e2e tests | ||
|
|
||
|
|
||
| Implicitly, all e2e tests for your operating system are executed. If you want to run only tests from one feature file, you have to override `GODOG_OPTS` environment variable. For example: | ||
|
|
||
| ```bash | ||
| make e2e GODOG_OPTS="--godog.tags='@basic && @windows'" BUNDLE_LOCATION=<bundle location> PULL_SECRET_FILE=<pull secret path> | ||
| ``` | ||
|
|
||
| Please notice `@basic && @windows`, where `@basic` tag stands for `basic.feature` file and `@windows` tag for e2e tests designed for Windows. | ||
|
|
||
| ### How to test cert rotation | ||
|
|
||
| On linux platform first stop the network time sync using: | ||
|
|
||
| ```bash | ||
| $ sudo timedatectl set-ntp off | ||
| ``` | ||
|
|
||
| Set the time 2 month ahead: | ||
|
|
||
| ```bash | ||
| $ sudo date -s '2 month' | ||
| ``` | ||
|
|
||
| Start the crc with `CRC_DEBUG_ENABLE_STOP_NTP=true` set: | ||
|
|
||
| ```bash | ||
| $ CRC_DEBUG_ENABLE_STOP_NTP=true crc start | ||
| ``` | ||
|
|
||
| ### Logs | ||
|
|
||
| Test logs can be found in `test/e2e/out/test-results`. |