diff --git a/docs/autoupdate.rst b/docs/autoupdate.rst index 6e16eccf3..16c870961 100644 --- a/docs/autoupdate.rst +++ b/docs/autoupdate.rst @@ -38,9 +38,9 @@ The ``autoupdate`` subcommand can also be used to automatically update workflows planemo autoupdate workflow.ga -In the basic usage, a local Galaxy instance will be spun up and the workflow uploaded, refactored to include the most recent tool versions, and re-downloaded. +In the basic usage with the above command, a local Galaxy instance will be spun up and the workflow uploaded, refactored to include the most recent tool versions, and re-downloaded. -Workflows can also be updated against an external galaxy, for example: +Workflows can also be updated against an external Galaxy server; see the example below. (Please note the server must be running Galaxy version 21.05 or more recent.) :: @@ -48,6 +48,13 @@ Workflows can also be updated against an external galaxy, for example: In this case, the workflow returned will contain the most recent tool and subworkflow versions available on that Galaxy server. +An equivalent alternative, if you don't want to use Planemo profiles, is the following: + +:: + + planemo autoupdate workflow.ga --galaxy_url SERVER_URL --galaxy_user_key API_KEY + + Implementing an autoupdate CI job ================================= diff --git a/planemo/commands/cmd_autoupdate.py b/planemo/commands/cmd_autoupdate.py index 2259c467e..83a7197cd 100644 --- a/planemo/commands/cmd_autoupdate.py +++ b/planemo/commands/cmd_autoupdate.py @@ -78,6 +78,8 @@ def skip_requirements_option(): @options.report_level_option() @options.report_xunit() @options.fail_level_option() +@options.galaxy_url_option() +@options.galaxy_user_key_option() @command_function def cli(ctx, paths, **kwds): # noqa C901 """Auto-update tool requirements by checking against Conda and updating if newer versions are available."""