Skip to content

Trim the orf_class changelog entries to one sentence each - #227

Merged
pinin4fjords merged 1 commit into
devfrom
docs/trim-orf-class-changelog
Aug 11, 2026
Merged

Trim the orf_class changelog entries to one sentence each#227
pinin4fjords merged 1 commit into
devfrom
docs/trim-orf-class-changelog

Conversation

@FelixKrueger

@FelixKrueger FelixKrueger commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Trims #226's seven changelog entries to one sentence each, as @pinin4fjords asked on that PR. Two of them had grown into full paragraphs with migration instructions inline — 132 and 104 words. Total drops from 440 words to 136, and nothing is lost: the vocabulary, is_smorf, --smorf_max_aa and the positional-only rule are all already documented in docs/output.md and docs/usage.md, which the shortened breaking-change entry now points at.

No functional change.

@FelixKrueger
Trim the orf_class changelog entries to one sentence each
191c140 
Two had grown into paragraphs carrying migration instructions inline, at 132
and 104 words; the seven together drop from 440 words to 136.

Nothing is lost. The vocabulary, is_smorf, --smorf_max_aa and the
positional-only rule are documented in docs/output.md and docs/usage.md, and
the breaking-change entry now points there instead of restating them. A
changelog is read by someone deciding whether an upgrade affects them, not by
someone auditing the decision -- that belongs in the commit messages and the
PR thread.
@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown

Warning

Newer version of the nf-core template is available.

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

For more documentation on how to update your pipeline, please see the Synchronisation documentation.

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown

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

Posted for pipeline commit 191c140

+| ✅ 299 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗   6 tests had warnings |!
Details

❗ Test warnings:

  • 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 CONTRIBUTING.md: Add any pipeline specific contribution guidelines here, such as coding styles, procedures, checklists etc.
  • pipeline_if_empty_null - ifEmpty(null) found in /home/runner/work/riboseq/riboseq/subworkflows/local/prepare_genome/main.nf: _ versions = ch_versions.ifEmpty(null) // channel: [ versions.yml ]
    _
  • schema_lint - Input mimetype is missing or empty

❔ Tests ignored:

  • nextflow_config - Config default ignored: params.ribo_database_manifest
  • nf_test_content - nf_test_content
  • files_unchanged - File ignored due to lint config: assets/nf-core-riboseq_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-riboseq_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-riboseq_logo_dark.png
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore
  • merge_markers - Ignoring file /home/runner/work/riboseq/riboseq/modules/nf-core/bowtie2/align/tests/main.nf.test.snap

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.3
  • Run at 2026-08-11 11:25:06

@FelixKrueger
FelixKrueger enabled auto-merge August 11, 2026 13:44
@FelixKrueger FelixKrueger mentioned this pull request Aug 11, 2026
Open
@pinin4fjords
pinin4fjords disabled auto-merge August 11, 2026 14:07
@pinin4fjords
pinin4fjords merged commit b7c4bfd into dev Aug 11, 2026
5 checks passed
@pinin4fjords
pinin4fjords deleted the docs/trim-orf-class-changelog branch August 11, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pinin4fjords pinin4fjords pinin4fjords 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

@FelixKrueger @pinin4fjords