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

Documentation updates for the release #95

Merged
merged 10 commits into from
Dec 5, 2023
Merged

Documentation updates for the release #95

merged 10 commits into from
Dec 5, 2023

Conversation

muffato
Copy link
Member

@muffato muffato commented Nov 20, 2023 •
edited
Loading

This PR recapitulates all the non-code changes required before making a new release, e.g. documentation.

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
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile 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).

@muffato muffato added this to the 1.1.0 milestone Nov 20, 2023
@muffato muffato self-assigned this Nov 20, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 20, 2023 •
edited
Loading

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit ac668ea

+| ✅ 132 tests passed       |+
#| ❔  20 tests were ignored |#
!| ❗   1 tests had warnings |!

❗ Test warnings:

❔ Tests ignored:

  • files_exist - File is ignored: assets/nf-core-genomenote_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-genomenote_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-genomenote_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: conf/igenomes.config
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/config.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File does not exist: assets/nf-core-genomenote_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-genomenote_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-genomenote_logo_dark.png
  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy
  • actions_ci - actions_ci
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/genomenote/genomenote/.github/workflows/awstest.yml

✅ Tests passed:

Run details

  • nf-core/tools version 2.8
  • Run at 2023-11-23 09:27:13

@muffato muffato mentioned this pull request Nov 20, 2023
Merged
9 tasks
@muffato muffato changed the title Misc. updates for the release Documentation updates for the release Nov 20, 2023
@muffato muffato mentioned this pull request Nov 20, 2023
Merged
9 tasks
@muffato
Added Guoying to the author list
a3b139a 
by alphabetical order
@muffato muffato marked this pull request as ready for review November 20, 2023 17:42
@muffato muffato added the documentation Improvements or additions to documentation label Nov 20, 2023
BethYates
BethYates reviewed Dec 5, 2023
View reviewed changes
Copy link
Contributor

@BethYates BethYates left a comment

Choose a reason for hiding this comment

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

If the fix for completeness score sometimes being set to 0 is going into this release does it need adding to the changelog?

@muffato
Copy link
Member Author

muffato commented Dec 5, 2023

I would rather review/merge this PR on the basis of previous PRs/feature changes, and mandate that any further PR that targets this release updates the changelog and documentation accordingly.

@muffato muffato merged commit 6ab85f7 into dev Dec 5, 2023
6 checks passed
@muffato muffato deleted the new_release branch December 5, 2023 15:48
@muffato muffato added the maintain Tasks to keep pipelines up to date label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BethYates BethYates BethYates approved these changes

Assignees

@muffato muffato

Labels
documentation Improvements or additions to documentation maintain Tasks to keep pipelines up to date
Projects
Genome After Party
Status: Done
Milestone
1.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@muffato @BethYates