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.

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

Template update #10

Merged
merged 39 commits into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
0a9c648
Template update for nf-core/tools version 2.6
muffato Jul 14, 2023
9e07b9b
Template update for nf-core/tools version 2.7
muffato Jul 14, 2023
93863d6
Template update for nf-core/tools version 2.8
muffato Jul 14, 2023
bfce31f
[linting] prettier
muffato Jul 14, 2023
31e5f8c
[linting] black
muffato Jul 14, 2023
ed0b297
Merge branch 'TEMPLATE' into dev
muffato Jul 14, 2023
9284bfb
Merge branch 'TEMPLATE' into dev
muffato Jul 14, 2023
bcb2b50
Merge branch 'TEMPLATE' into dev
muffato Jul 14, 2023
23f24b7
Fixed the modules installation
muffato Jul 14, 2023
9268ef6
Fixed the modules path
muffato Jul 14, 2023
2d86b29
Now need nf-core 2.8
muffato Jul 15, 2023
f9dadd0
we use prettier for the cff files
muffato Jul 15, 2023
cb4d091
Need to use Nextflow.error
muffato Jul 15, 2023
4540aa1
[linting] prettier
muffato Jul 15, 2023
931c243
Fixed the Conda directives
muffato Jul 15, 2023
435fcf1
The quay.io prefix should now be skipped
muffato Jul 15, 2023
a9551d5
No output for Tower
muffato Jul 15, 2023
1d2524a
We don't use MultiQC
muffato Jul 15, 2023
7254f04
Fixed the wget conda package
muffato Jul 15, 2023
890dbb6
[linting] prettier
muffato Jul 15, 2023
e903d25
was 2 before the template update
muffato Jul 15, 2023
81178e5
We do this through a profile
muffato Jul 15, 2023
b540ef3
Fixed the example params.yaml
muffato Jul 15, 2023
9682670
[linting] prettier
muffato Jul 15, 2023
d7951cf
We don't make shared sanger-tol workflows anymore
muffato Jul 15, 2023
f17c776
Not needed
muffato Jul 15, 2023
d3ade99
This file is now identical
muffato Jul 15, 2023
8d9bc1c
Leftover from a copy
muffato Jul 31, 2023
7b33db6
Added a redirection notice to the pipeline website
muffato Jul 31, 2023
c2a374f
The convention is now to put all the pipeline_info files in per-pipel…
muffato Jul 31, 2023
7777314
Added the code of conduct back
muffato Jul 31, 2023
00badc4
There is no parameters.md page anymore
muffato Jul 31, 2023
3c42dfa
Fixed README - now matching the template and linking to the pipeline …
muffato Jul 31, 2023
44fbe8b
Updated the DOI
muffato Aug 3, 2023
24eea75
This is superfluous
muffato Aug 3, 2023
a94039d
Updated the contributions
muffato Aug 3, 2023
322ca6c
Added options to submit the pipelines to the farm from GitHub
muffato Aug 3, 2023
e1b927d
docfix
muffato Aug 4, 2023
e24a6f7
Latest nomenclature
muffato Aug 10, 2023
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
27 changes: 27 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name": "nfcore",
"image": "nfcore/gitpod:latest",
"remoteUser": "gitpod",

// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/opt/conda/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/opt/conda/bin/autopep8",
"python.formatting.yapfPath": "/opt/conda/bin/yapf",
"python.linting.flake8Path": "/opt/conda/bin/flake8",
"python.linting.pycodestylePath": "/opt/conda/bin/pycodestyle",
"python.linting.pydocstylePath": "/opt/conda/bin/pydocstyle",
"python.linting.pylintPath": "/opt/conda/bin/pylint"
},

// Add the IDs of extensions you want installed when the container is created.
"extensions": ["ms-python.python", "ms-python.vscode-pylance", "nf-core.nf-core-extensionpack"]
}
}
}
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ trim_trailing_whitespace = true
indent_size = 4
indent_style = space

[*.{md,yml,yaml,html,css,scss,js,cff}]
[*.{md,yml,yaml,html,css,scss,js}]
indent_size = 2

# These files are edited and tested upstream in nf-core/modules
Expand Down
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
*.config linguist-language=nextflow
*.nf.test linguist-language=nextflow
modules/nf-core/** linguist-generated
modules/sanger-tol/** linguist-generated
subworkflows/nf-core/** linguist-generated
subworkflows/sanger-tol/** linguist-generated
16 changes: 16 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,19 @@ If you are using a new feature from core Nextflow, you may bump the minimum requ
### Images and figures

For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).

## GitHub Codespaces

This repo includes a devcontainer configuration which will create a GitHub Codespaces for Nextflow development! This is an online developer environment that runs in your browser, complete with VSCode and a terminal.

To get started:

- Open the repo in [Codespaces](https://github.com/sanger-tol/insdcdownload/codespaces)
- Tools installed
- nf-core
- Nextflow

Devcontainer specs:

- [DevContainer config](.devcontainer/devcontainer.json)
- [Dockerfile](.devcontainer/Dockerfile)
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ body:
id: system
attributes:
label: System information
description: "* Nextflow version _(eg. 22.04.0)_
description: "* Nextflow version _(eg. 22.10.1)_

* Hardware _(eg. HPC, Desktop, Cloud)_

* Executor _(eg. slurm, local, awsbatch)_

* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter or Charliecloud)_
* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter, Charliecloud,
or Apptainer)_

* OS _(eg. CentOS Linux, macOS, Linux Mint)_

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: Check PRs
if: github.repository == 'sanger-tol/insdcdownload'
run: |
{ [[ ${{github.event.pull_request.head.repo.full_name }} == sanger-tol/insdcdownload ]] && [[ $GITHUB_HEAD_REF = "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
{ [[ ${{github.event.pull_request.head.repo.full_name }} == sanger-tol/insdcdownload ]] && [[ $GITHUB_HEAD_REF == "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]

# If the above check failed, post a comment on the PR explaining the failure
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ on:
env:
NXF_ANSI_LOG: false

concurrency:
group: "${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}"
cancel-in-progress: true

jobs:
test:
name: Run pipeline with test data
Expand All @@ -20,11 +24,11 @@ jobs:
strategy:
matrix:
NXF_VER:
- "22.10.0"
- "22.10.1"
- "latest-everything"
steps:
- name: Check out pipeline code
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Install Nextflow
uses: nf-core/setup-nextflow@v1
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/clean-up.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "Close user-tagged issues and PRs"
on:
schedule:
- cron: "0 0 * * 0" # Once a week

jobs:
clean-up:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/stale@v7
with:
stale-issue-message: "This issue has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor. Remove stale label or add a comment otherwise this issue will be closed in 20 days."
stale-pr-message: "This PR has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor. Remove stale label or add a comment if it is still useful."
close-issue-message: "This issue was closed because it has been tagged as awaiting-changes or awaiting-feedback by an nf-core contributor and then staled for 20 days with no activity."
days-before-stale: 30
days-before-close: 20
days-before-pr-close: -1
any-of-labels: "awaiting-changes,awaiting-feedback"
exempt-issue-labels: "WIP"
exempt-pr-labels: "WIP"
repo-token: "${{ secrets.GITHUB_TOKEN }}"
6 changes: 3 additions & 3 deletions .github/workflows/fix-linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.nf_core_bot_auth_token }}

- uses: actions/setup-node@v2
- uses: actions/setup-node@v3

- name: Install Prettier
run: npm install -g prettier @prettier/plugin-php
Expand All @@ -34,9 +34,9 @@ jobs:
id: prettier_status
run: |
if prettier --check ${GITHUB_WORKSPACE}; then
echo "::set-output name=result::pass"
echo "result=pass" >> $GITHUB_OUTPUT
else
echo "::set-output name=result::fail"
echo "result=fail" >> $GITHUB_OUTPUT
fi

- name: Run 'prettier --write'
Expand Down
24 changes: 13 additions & 11 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ name: nf-core linting
# that the code meets the nf-core guidelines.
on:
push:
branches:
- dev
pull_request:
release:
types: [published]
Expand All @@ -12,22 +14,22 @@ jobs:
EditorConfig:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: actions/setup-node@v2
- uses: actions/setup-node@v3

- name: Install editorconfig-checker
run: npm install -g editorconfig-checker

- name: Run ECLint check
run: editorconfig-checker -exclude README.md $(find .* -type f | grep -v '.git\|.py\|.md\|json\|yml\|yaml\|html\|css\|work\|.nextflow\|build\|nf_core.egg-info\|log.txt\|Makefile')
run: editorconfig-checker -exclude README.md $(find .* -type f | grep -v '.git\|.py\|.md\|cff\|json\|yml\|yaml\|html\|css\|work\|.nextflow\|build\|nf_core.egg-info\|log.txt\|Makefile')

Prettier:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: actions/setup-node@v2
- uses: actions/setup-node@v3

- name: Install Prettier
run: npm install -g prettier
Expand All @@ -38,7 +40,7 @@ jobs:
PythonBlack:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Check code lints with Black
uses: psf/black@stable
Expand Down Expand Up @@ -69,20 +71,20 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out pipeline code
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Install Nextflow
uses: nf-core/setup-nextflow@v1

- uses: actions/setup-python@v3
- uses: actions/setup-python@v4
with:
python-version: "3.7"
python-version: "3.8"
architecture: "x64"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install nf-core==2.5.0
pip install nf-core==2.8

- name: Run nf-core lint
env:
Expand All @@ -97,7 +99,7 @@ jobs:

- name: Upload linting log file artifact
if: ${{ always() }}
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v3
with:
name: linting-logs
path: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linting_comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:

- name: Get PR number
id: pr_number
run: echo "::set-output name=pr_number::$(cat linting-logs/PR_number.txt)"
run: echo "pr_number=$(cat linting-logs/PR_number.txt)" >> $GITHUB_OUTPUT

- name: Post PR comment
uses: marocchino/sticky-pull-request-comment@v2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: nf-core Sanger LSF tests
name: sanger-tol LSF tests

on:
workflow_dispatch:
Expand All @@ -20,4 +20,4 @@ jobs:
{
"outdir": "${{ secrets.TOWER_WORKDIR_PARENT }}/results/${{ github.repository }}/results-${{ github.sha }}",
}
profiles: test,sanger,singularity
profiles: test,sanger,singularity,cleanup
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: nf-core Sanger LSF full size tests
name: sanger-tol LSF full size tests

on:
push:
Expand Down Expand Up @@ -34,4 +34,4 @@ jobs:
{
"outdir": "${{ secrets.TOWER_WORKDIR_PARENT }}/results/${{ github.repository }}/results-${{ env.REVISION }}",
}
profiles: test_full,sanger,singularity
profiles: test_full,sanger,singularity,cleanup
3 changes: 0 additions & 3 deletions .nf-core.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
repository_type: pipeline
lint:
files_exist:
- CODE_OF_CONDUCT.md
- assets/multiqc_config.yml
- assets/nf-core-insdcdownload_logo_light.png
- conf/igenomes.config
Expand All @@ -12,12 +11,10 @@ lint:
- .github/workflows/awsfulltest.yml
files_unchanged:
- LICENSE
- .gitattributes
- .github/CONTRIBUTING.md
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/workflows/linting.yml
- assets/sendmail_template.txt
- docs/README.md
- lib/NfcoreTemplate.groovy
nextflow_config:
- manifest.name
Expand Down
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v2.7.1"
hooks:
- id: prettier
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
email_template.html
adaptivecard.json
slackreport.json
.nextflow*
work/
data/
Expand All @@ -7,3 +9,4 @@ results/
testing/
testing*
*.pyc
bin/
24 changes: 12 additions & 12 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@
cff-version: 1.2.0
title: sanger-tol/insdcdownload v1.1.0 - Deciduous ent
message: >-
If you use this software, please cite it using the
metadata from this file.
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Matthieu
family-names: Muffato
affiliation: Wellcome Sanger Institute
orcid: "https://orcid.org/0000-0002-7860-3560"
- given-names: Priyanka
family-names: Surana
orcid: "https://orcid.org/0000-0002-7167-0875"
affiliation: Wellcome Sanger Institute
- given-names: Matthieu
family-names: Muffato
affiliation: Wellcome Sanger Institute
orcid: "https://orcid.org/0000-0002-7860-3560"
- given-names: Priyanka
family-names: Surana
orcid: "https://orcid.org/0000-0002-7167-0875"
affiliation: Wellcome Sanger Institute
identifiers:
- type: doi
value: 10.5281/zenodo.7155119
- type: doi
value: 10.5281/zenodo.6983932
repository-code: "https://github.com/sanger-tol/insdcdownload"
license: MIT
commit: TODO
Expand Down
Loading