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.

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

Add the option to provide a history id to run the workflow in #1461

Merged
merged 2 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/commands/lint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ Check for common errors and best practices.
(e.g. passing --skip 'citations,xml_order'
would skip linting of citations and best-
practice XML ordering.
--xsd / --no_xsd Include tool XSD validation in linting
process.
--skip_file FILE File containing a list of lint tests to skip
-r, --recursive Recursively perform command for
subdirectories.
--urls Check validity of URLs in XML files
Expand Down
3 changes: 3 additions & 0 deletions docs/commands/run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ Planemo command for running tools and jobs.
--galaxy_user_key TEXT User key to use with external Galaxy engine.
--history_name TEXT Name to give a Galaxy history, if one is
created.
--history_id TEXT Send the results of the run to the history
with the provided ID. A history with this ID
must exist.
--no_wait After invoking a job or workflow, do not wait
for completion.
--paste_test_data_paths / --no_paste_test_data_paths
Expand Down
3 changes: 1 addition & 2 deletions docs/commands/shed_lint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,9 @@ help text for mentioned URLs and checks those.
(e.g. passing --skip 'citations,xml_order'
would skip linting of citations and best-
practice XML ordering.
--skip_file FILE File containing a list of lint tests to skip
--tools Lint tools discovered in the process of
linting repositories.
--xsd / --no_xsd Include tool XSD validation in linting
process.
--ensure_metadata Ensure .shed.yml files contain enough metadata
for each repository to allow automated
creation and/or updates.
Expand Down
3 changes: 3 additions & 0 deletions docs/commands/test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,9 @@ please careful and do not try this against production Galaxy instances.
--galaxy_user_key TEXT User key to use with external Galaxy engine.
--history_name TEXT Name to give a Galaxy history, if one is
created.
--history_id TEXT Send the results of the run to the history
with the provided ID. A history with this ID
must exist.
--no_wait After invoking a job or workflow, do not wait
for completion.
--help Show this message and exit.
Expand Down
9 changes: 9 additions & 0 deletions planemo/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,14 @@ def history_name():
)


def history_id():
return planemo_option(
"--history_id",
type=str,
help="Send the results of the run to the history with the provided ID. A history with this ID must exist.",
)


def no_cache_galaxy_option():
return planemo_option(
"--no_cache_galaxy",
Expand Down Expand Up @@ -1495,6 +1503,7 @@ def engine_options():
galaxy_admin_key_option(),
galaxy_user_key_option(),
history_name(),
history_id(),
no_wait_option(),
)

Expand Down
Loading