Skip to content

Workflow tutorial is anchored to the archived usegalaxy-eu/workflow-testing repo #1718

Description

@jmchilton

Posted by Claude (AI assistant) on behalf of jmchilton — they did not author this text.

The workflow getting-started tutorial in docs/_running_intro.rst anchors the reader to a repository that has been archived for over four years.

$ git clone https://github.com/usegalaxy-eu/workflow-testing.git
$ cd workflow-testing/example3

usegalaxy-eu/workflow-testing is archived, last pushed 2021-02-19. Because archived repos stay readable, git clone still succeeds and example3 still resolves — so the tutorial is not broken, which is probably why this has gone unnoticed. But planemo's front-door introduction to running and testing workflows is built on a dead repository.

It is referenced four times in docs/_running_intro.rst (lines 5, 11, 12, and in the sample output on line 55).

Background

This was raised during review of #1426, where a maintainer noted that readers should be testing workflows from the IWC rather than usegalaxy-eu/workflow-testing, which "isn't very active or easily debuggable": #1426 (comment)

No action was taken at the time.

What needs deciding

Which IWC workflow replaces example3. The tutorial needs something that is small, fast to run on a locally hosted Galaxy, and ships both a job file and a test file, since the tutorial walks through planemo run and then planemo test against the same artifact.

Candidates worth sizing up:

  • workflows/read-preprocessing/short-read-qc-trimming
  • workflows/data-fetching/parallel-accession-download

Whatever is chosen, the tutorial's sample outputs (the planemo run JSON on line 55 and the tutorial-tests.yml excerpt) have to be regenerated to match, not just re-pointed.

Related

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions