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

Pr checklist before release #71

Merged
merged 15 commits into from
Aug 21, 2024
Merged

Pr checklist before release #71

merged 15 commits into from
Aug 21, 2024

Conversation

danilodileo
Copy link
Collaborator

@danilodileo danilodileo commented Aug 13, 2024 •
edited
Loading

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/magmap branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

As title suggests I tried to fix small typos as other things that will make the reviewing process easier.

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 13, 2024 •
edited
Loading

nf-core lint overall result: Failed ❌

Posted for pipeline commit a499f74

+| ✅ 202 tests passed       |+
!| ❗   3 tests had warnings |!
-| ❌   2 tests failed       |-

❌ Test failures:

  • files_unchanged - docs/images/nf-core-magmap_logo_light.png does not match the template
  • files_unchanged - docs/images/nf-core-magmap_logo_dark.png does not match the template

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-08-21 07:17:24

erikrikarddaniel
erikrikarddaniel approved these changes Aug 13, 2024
View reviewed changes
Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

Mostly good, with a few comments and suggestions. Approving, although I saw some tests were failing.

README.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
danilodileo and others added 3 commits August 21, 2024 09:11
@danilodileo danilodileo merged commit 0184d26 into nf-core:dev Aug 21, 2024
3 of 4 checks passed
@danilodileo danilodileo deleted the PR-checklist-before-release branch August 22, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erikrikarddaniel erikrikarddaniel erikrikarddaniel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@danilodileo @erikrikarddaniel