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

Jump to bottom

Add CI to contributing #703

Merged
merged 4 commits into from
Feb 21, 2024
Merged

Add CI to contributing #703

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd2944a
add contributing section about CI nested in PRs
sjspielman Feb 21, 2024
551753a
Update CONTRIBUTING.md
sjspielman Feb 21, 2024
e35d455
update language about required checks, and precommit ci only runs on …
sjspielman Feb 21, 2024
53f9f4b
not just on development
sjspielman Feb 21, 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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ To allow for efficient review, please include in any pull request a concise and

When the changes in `development` merit a new release, a pull request will be filed to merge the current version of the `development` branch into `main`, followed by tagging a release on the `main` branch.

### Continuous integration in pull requests

There are several automatic checks performed by GitHub Actions in all pull requests filed to `main` or `development`.

These checks are required to pass before pull requests can be merged:

- [Spell check R Markdown and Markdown files](.github/workflows/spell-check.yml): This workflow ensures there are no spelling errors in R Markdown and Markdown files.
- [Check Nextflow stub](.github/workflows/nextflow-stub-check.yaml): This workflow ensures that the [stub workflow](#stub-workflows) runs without errors.
- [Check Nextflow config](.github/workflows/nextflow-config-check.yaml): This workflow ensures that there are no syntax errors in the Nextflow configuration files
sjspielman marked this conversation as resolved.
Show resolved Hide resolved

There is also one additional `pre-commit ci` workflow which runs all [pre-commit hooks as described in this section](#pre-commit-hooks), except for the spell check pre-commit hook.
Although highly recommended, it is not required that this workflow passes before pull requests can be merged.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spell check is not required to pass either, the way this repo is currently set up.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, didn't know that! Also looks like the precommit ci only runs on development (if i'm reading the yaml syntax correctly), so will change that too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it runs everywhere. That is where it files its PRs to (when updating hook versions)


## Stub workflows

All Nextflow processes should include a [`stub` block](https://www.nextflow.io/docs/latest/process.html#stub) with a minimal script that can be run quickly to produce files in the expected output locations.
Expand Down
Loading