Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes to bot documentation #326

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Minor changes to bot documentation #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
974fced
Update bot docs
Neves-P Oct 14, 2024
9e1a323
prettify link
Neves-P Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions docs/bot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Separate filters with a space, order of filters does not matter.
For example:

```
bot: build repo:eessi-hpc.org-2023.06-software arch:x86_64/amd/zen2
bot: build repo:eessi.io-2023.06-software arch:x86_64/amd/zen2
```

#### Multiple build instructions
Expand All @@ -108,8 +108,8 @@ repositories, and CPU targets. Specify one build instruction per line.
For example:

```
bot: build repo:eessi-hpc.org-2023.06-software arch:x86_64/amd/zen3 inst:aws
bot: build repo:eessi-hpc.org-2023.06-software arch:aarch64/generic inst:azure
bot: build repo:eessi.io-2023.06-software arch:x86_64/amd/zen3 inst:aws
bot: build repo:eessi.io-2023.06-software arch:x86_64/amd/zen4 inst:azure
```

!!! note
Expand Down Expand Up @@ -154,15 +154,11 @@ which was created by the `bot/check-result.sh` script.

## Testing { #testing }

!!! warning
The test phase is not implemented yet in the bot.

We intend to use the [EESSI test suite](https://github.com/EESSI/test-suite)
in different OS configurations to verify that the software that was built works as expected.
The bot also runs tests in the [EESSI test suite](test-suite/index.md) if these match the software being installed. These tests are run after the build step by the bot through the `bot/test.sh` script. The mapping of which tests will run given the built software is defined in `tests/eessi_test_mapping/software_to_tests.yml`. Lastly, the job manager reports a summary of the test results created by the `bot/check-test.sh` script.

## Deploying { #deploying }

To deploy the artefacts that were obtained in the build phase, you should add the `bot: deploy` label
To deploy the artefacts that were obtained in the build phase, you should add the `bot:deploy` label
to the pull request.

This will trigger the event handler to upload the artefacts for ingestion into the EESSI repository.
Expand Down
2 changes: 1 addition & 1 deletion docs/test-suite/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To get started, you should look into the [installation and configuration guideli

To write the ReFrame configuration file for your system, check [ReFrame configuration file](ReFrame-configuration-file.md).

For which software tests are available, see [available-tests.md](available-tests.md).
For which software tests are available, see [available tests](available-tests.md).

For more information on using the EESSI test suite, see [here](usage.md).

Expand Down
Loading