Adding files
The page you are taken to presents four options for registering a workflow and its associated files.
Recommendation
We recommend referencing the files, for example towards a GitHub repo, since we want to be a hub and not a repository for workflows.
This also allows us to show the source link of the RO-Crate on the workflow page and include this in the RO-Crate metadata. In case the referencing would not work, for example with referencing Galaxy instances, you can always use the source metadata field later in the registration.
Upload / import a local file
- Select your local workflow file using the
Browse…
button - Pick your workflow type - if your workflow type is not included in the list you can select
Other
or add aNew workflow type
using the available button. - Optional: add in a Abstract CWL using the
Browse…
button - Optional: add in a Diagram file using the
Browse…
button - Click the
Register
button
Fig 2. New workflow tab for uploading / importing local files.
Upload / import using a remote file URL
- Add your remote file URL - click
Test
to check the URL - Pick your workflow type - if your workflow type is not included in the list you can select Other or add a
New workflow type
using the available button. - Optional: add a remote URL for the Abstract CWL - click
Test
to check the URL - Optional: add a remote URL for the Diagram file - click
Test
to check the URL - Click the
Register
button
Fig 3. New workflow tab for importing files from a remote URL.
Importing a Git repository
- Add your Git repository URL e.g.
https://github.com/username/repository_name
- Click the
Register
button
Fig 4. New workflow tab for importing files from a git repository (e.g. GitHub, GitLab).
- When you have selected to import a specific Git repository URL (i.e. by clicking
Register
) you will be prompted to specify either a repository:- Branch, or
- Release tag
- Once you click
Register
again, you will gain access to a drop down list of the files in the repository - pick the[main executable workflow file](/docs/glossary#main-workflow)
:- For a NextFlow workflow for example, this would be the
.nf
file - For a series of bash scripts, this would be the first
.sh
file or theREADME.md
file
- For a NextFlow workflow for example, this would be the
- You can now pick additional optional files as well:
- Click
Continue
to proceed to the metadata stage
Fig 5. Selecting a target branch or release tag as well as the main executable and optional files during Git repository import.
Upload / Import a workflow RO-Crate
- Add an RO-Crate zip file, either via:
- A local file upload using the
Browse…
button, or - By adding a remote file URL - click
Test
to check the URL
- A local file upload using the
- Click the
Register
button
Fig 6. New workflow tab for importing files using a Research Object Crate (RO-Crate).