Skip to content

featureCounts: apply IUC tool_xml formatting conventions#8090

Open
richard-burhans wants to merge 1 commit into
galaxyproject:mainfrom
richard-burhans:featurecounts-format-profile26.1
Open

featureCounts: apply IUC tool_xml formatting conventions#8090
richard-burhans wants to merge 1 commit into
galaxyproject:mainfrom
richard-burhans:featurecounts-format-profile26.1

Conversation

@richard-burhans

@richard-burhans richard-burhans commented Jun 11, 2026

Copy link
Copy Markdown
Member

Applies the IUC tool_xml formatting conventions to featureCounts. Reworked after the earlier review: this revision is formatting-only and deliberately drops the things raised on the first pass.

What changed:

  • normalize <param> attribute order to the best-practices coding-style order (name, argument, type, min/max, value, ...), and likewise value/ftype/dbkey order in the test params
  • self-close empty elements

What this revision intentionally does NOT do, per the earlier feedback:

  • no profile change (stays 25.0)
  • no blank lines between top-level sections
  • no XML declaration added
  • command-line quoting is limited to input and output files only (text params left alone)

The only non-formatting change is bumping @VERSION_SUFFIX@ 1 → 2, which planemo shed_lint requires for a changed, already-published tool to republish. The command line is unchanged in behavior.

Comment thread tools/featurecounts/featurecounts.xml Outdated
Comment thread tools/featurecounts/featurecounts.xml Outdated
Comment thread tools/featurecounts/featurecounts.xml

@bernt-matthias bernt-matthias left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would suggest to keep the profile and merge without bump.

In the end none of the changes is really necessary. Also we do not have a normal form for the order of attributes.

Comment thread tools/featurecounts/featurecounts.xml Outdated
@mvdbeek

mvdbeek commented Jun 12, 2026

Copy link
Copy Markdown
Member

I would suggest to keep the profile and merge without bump.

that makes publishing bug fixes impossible / hard. the profile version allows opting into newer behavior, but there isn't even a documented change after 25.1, and even the 25.1 behavior doesn't apply here.

@richard-burhans

Copy link
Copy Markdown
Member Author

I would suggest to keep the profile and merge without bump.

In the end none of the changes is really necessary. Also we do not have a normal form for the order of attributes.

The order was taken from the best practices documentation: https://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/tool_xml.html#coding-style

@richard-burhans

Copy link
Copy Markdown
Member Author

I would suggest to keep the profile and merge without bump.
In the end none of the changes is really necessary. Also we do not have a normal form for the order of attributes.

The order was taken from the best practices documentation: https://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/tool_xml.html#coding-style

I think I was too aggressive here, the documentation states "variables for text parameters, input and output files". I'll make sure I'm only quoting what the documentation mentions.

@mvdbeek

mvdbeek commented Jun 12, 2026

Copy link
Copy Markdown
Member

The order was taken from the best practices documentation: https://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/tool_xml.html#coding-style

one year older would be 25.0, which is still insanely strict. certainly when we're only causing problems and get no benefit whatsoever.

@mvdbeek

mvdbeek commented Jun 12, 2026

Copy link
Copy Markdown
Member

@richard-burhans

Copy link
Copy Markdown
Member Author

The order was taken from the best practices documentation: https://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/tool_xml.html#coding-style

one year older would be 25.0, which is still insanely strict. certainly when we're only causing problems and get no benefit whatsoever.

Across the five major servers (org, eu, org.au, fr, ca) 25.1 is the oldest version running.

@mvdbeek

mvdbeek commented Jun 12, 2026

Copy link
Copy Markdown
Member

We are an open community with plenty of servers we don't even know about, and you can search through the IUC issues to find out that people are indeed facing problems with this: https://github.com/galaxyproject/tools-iuc/issues?q=is%3Aissue%20state%3Aclosed%20profile. We've added the profile version feature so that we can roll out better defaults while maintaining reproducible behavior for older tools. Sticking to one interpretation of a document in a way that wasn't even ever intended (26.1 isn't released yet) and forcing people to upgrade their instance is not what we should do. And I repeat, there's nothing we actually gain from doing this except for alienating our user base.

@richard-burhans

Copy link
Copy Markdown
Member Author

We are an open community with plenty of servers we don't even know about, and you can search through the IUC issues to find out that people are indeed facing problems with this: https://github.com/galaxyproject/tools-iuc/issues?q=is%3Aissue%20state%3Aclosed%20profile. We've added the profile version feature so that we can roll out better defaults while maintaining reproducible behavior for older tools. Sticking to one interpretation of a document in a way that wasn't even ever intended (26.1 isn't released yet) and forcing people to upgrade their instance is not what we should do. And I repeat, there's nothing we actually gain from doing this except for alienating our user base.

This is why I changed the way my code worked after your first comment.

@richard-burhans richard-burhans force-pushed the featurecounts-format-profile26.1 branch from 80b0b0a to b842c2b Compare June 13, 2026 04:09
@richard-burhans richard-burhans changed the title featureCounts: tidy formatting and bump profile to 26.1 featureCounts: apply IUC formatting conventions Jun 13, 2026
@richard-burhans richard-burhans force-pushed the featurecounts-format-profile26.1 branch 2 times, most recently from 24f9e5f to 5f53e0d Compare June 13, 2026 04:27
@github-project-automation github-project-automation Bot moved this from Triage/Discuss to Blocked / Not Planned in Galaxy Tool Developers SIG Board Jun 14, 2026
@github-project-automation github-project-automation Bot moved this from Blocked / Not Planned to In progress in Galaxy Tool Developers SIG Board Jun 14, 2026
@richard-burhans richard-burhans force-pushed the featurecounts-format-profile26.1 branch from 5f53e0d to a80d64f Compare June 14, 2026 21:42
@richard-burhans richard-burhans changed the title featureCounts: apply IUC formatting conventions featureCounts: apply IUC tool_xml formatting conventions Jun 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

4 participants