Skip to content

(Re)move job_conf.xml.sample_advanced #20406

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.

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

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

bernt-matthias
Copy link
Contributor

The sample config is one of the main sources of docs for job configuration. Unfortunately docs are sometimes still added to the good old xml sample config (eg #18628).

Here I suggest to (re) move the xml sample config (only keeping it for testing).
I manually went through the yml and xml version of the files and tried to sync them.

Alternatively we can strip the XML of all comments and add a reference to the yaml file.

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@github-actions github-actions bot added this to the 25.1 milestone Jun 5, 2025
@bernt-matthias bernt-matthias force-pushed the del_job_conf.xml.sample_advanced branch 2 times, most recently from a4ea4e6 to fea856b Compare June 5, 2025 09:51
@bernt-matthias bernt-matthias force-pushed the del_job_conf.xml.sample_advanced branch from fea856b to a888ccb Compare June 5, 2025 10:03
@martenson martenson added the kind/refactoring cleanup or refactoring of existing code, no functional changes label Jun 5, 2025
@martenson
Copy link
Member

This is a great idea, I've been bitten by the docs being different between xml and yaml before. fwiw the CI fails seem relevant

@bernt-matthias bernt-matthias force-pushed the del_job_conf.xml.sample_advanced branch 2 times, most recently from 303e926 to e00c6d7 Compare June 5, 2025 15:08
@bernt-matthias bernt-matthias force-pushed the del_job_conf.xml.sample_advanced branch from e00c6d7 to 2a0e2a9 Compare June 5, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/jobs area/testing kind/refactoring cleanup or refactoring of existing code, no functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants