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

ci: Skip nf-test on docs changes #1761

Merged
merged 2 commits into from
Feb 25, 2025
Merged

ci: Skip nf-test on docs changes #1761

merged 2 commits into from
Feb 25, 2025

Conversation

edmundmiller
Copy link
Contributor

Skips nf-test on any docs changes.

We can probably cut docs/** if we want to save lines 🙃

@edmundmiller @jfy133
ci: Skip nf-test on docs changes
594ef1d 
Co-authored-by: jfy133 <jfy133@users.noreply.github.com>
@edmundmiller edmundmiller self-assigned this Dec 12, 2024
@nf-core-bot
Copy link
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.0.2.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 12, 2024 •
edited
Loading

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 85c6c32

+| ✅ 214 tests passed       |+
#| ❔  11 tests were ignored |#
!| ❗   5 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 3.5.0
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.0.2
  • Run at 2024-12-12 21:56:19

maxulysse
maxulysse reviewed Dec 12, 2024
View reviewed changes
@jfy133
Copy link
Member

jfy133 commented Dec 12, 2024

The tests still ran though, no?

@edmundmiller @maxulysse
Update .github/workflows/ci.yml
85c6c32 
Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>
@edmundmiller
Copy link
Contributor Author

The tests still ran though, no?

This modified a GitHub action yml not a doc 😜

@jfy133
Copy link
Member

jfy133 commented Dec 13, 2024

The tests still ran though, no?

This modified a GitHub action yml not a doc 😜

Oh haha fair, but maybe worth modifying a doc as a test? 😬

maxulysse
maxulysse requested changes Feb 24, 2025
View reviewed changes
Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

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

CHANGELOG?

@edmundmiller
Copy link
Contributor Author

First, happy to update it.

But that request brought up a bigger question for me.

IMO the CI change doesn't affect end users. Most developers aren't going to notice this one.

Almost feels like we need a separate changelog or developers or call the git log good enough.

I personally vote we don't update the changelog unless it's changing the user experience. Didn't flags, different tools so expect a different result.

@maxulysse maxulysse merged commit 79f9f82 into dev Feb 25, 2025
39 checks passed
@maxulysse maxulysse deleted the skip-docs-ci branch February 25, 2025 11:42
@mashehu
Copy link
Contributor

mashehu commented Feb 25, 2025

nuh, these kind of DX related changes shouldn't occur so often and don't really fill up the changelog, so better to add it there then to never mention it 🙂 (also might help other devs to discover these changes)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxulysse maxulysse maxulysse approved these changes

@FriederikeHanssen FriederikeHanssen Awaiting requested review from FriederikeHanssen

@jfy133 jfy133 Awaiting requested review from jfy133

Assignees

@edmundmiller edmundmiller

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@edmundmiller @nf-core-bot @jfy133 @mashehu @maxulysse