Skip to content

Add docs for bot command to update template nf-test snapshots #3478

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for bot command to update template nf-test snapshots #3478

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions sites/docs/src/content/docs/contributing/github/nf-core-bot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ This will update the changelog entry with the title of the Pull Request or the v
Available in [nf-core/tools](https://github.com/nf-core/tools/blob/main/.github/workflows/changelog.yml).
:::

## `@nf-core-bot update snapshots`
## `@nf-core-bot update textual snapshots`

If the Textual snapshots (run by `tests/pipelines/test_crate_app.py`) fail, an HTML report is generated and uploaded as an artifact.
You can automatically update the snapshots from the PR by posting a comment with the magic words:

```bash
@nf-core-bot update snapshots
@nf-core-bot update textual snapshots
```

:::warning
Expand All @@ -74,3 +74,20 @@ Please always check the HTML report to make sure that the changes are expected.
:::info
Available in [nf-core/tools](https://github.com/nf-core/tools/blob/main/.github/workflows/update-textual-snapshots.yml).
:::

## `@nf-core-bot update template snapshots`

The tests in nf-core/tools "Create a pipeline from a template and test it" run by the GitHub Workflow `create-test-lint-wf-template.yml`, are testing pipelines created form the template and skipping each one of the possible template features.
If these tests fail, you can update the nf-test snapshots from the PR by posting a comment with the magic words:

```bash
@nf-core-bot update template snapshots
```

:::warning
Please always check the CI test output before updating the snapshots to make sure that the changes are expected.
:::

:::info
Available in [nf-core/tools](https://github.com/nf-core/tools/blob/main/.github/workflows/update-textual-snapshots.yml).
:::
Loading