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 *_diagrams.md to .gitignore. #637

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

dannon
Copy link
Member

@dannon dannon commented Dec 16, 2024

These are the mermaid diagrams generated during the site build process.

Alternatively, we could just include them and automatically update them on PR or periodically? One pro would be getting mermaid diagrams natively rendered on github. Potential cons would be we want folks to be viewing these on iwc.galaxyproject.org instead, and adds artifacts and noise to the repo that require keeping up to date?

FOR CONTRIBUTOR:

  • I have read the Adding workflows guidelines
  • License permits unrestricted use (educational + commercial)
  • Please also take note of the reviewer guidelines below to facilitate a smooth review process.

FOR REVIEWERS:

  • .dockstore.yml: file is present and aligned with creator metadata in workflow. ORCID identifiers are strongly encouraged in creator metadata. The .dockstore.yml file is required to run tests
  • Workflow is sufficiently generic to be used with lab data and does not hardcode sample names, reference data and can be run without reading an accompanying tutorial.
  • In workflow: annotation field contains short description of what the workflow does. Should start with This workflow does/runs/performs … xyz … to generate/analyze/etc …
  • In workflow: workflow inputs and outputs have human readable names (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless it is generally understood. Altering input or output labels requires adjusting these labels in the the workflow-tests.yml file as well
  • In workflow: name field should be human readable (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless generally understood
  • Workflow folder: prefer dash (-) over underscore (_), prefer all lowercase. Folder becomes repository in iwc-workflows organization and is included in TRS id
  • Readme explains what workflow does, what are valid inputs and what outputs users can expect. If a tutorial or other resources exist they can be linked. If a similar workflow exists in IWC readme should explain differences with existing workflow and when one might prefer one workflow over another
  • Changelog contains appropriate entries
  • Large files (> 100 KB) are uploaded to zenodo and location urls are used in test file

@mvdbeek
Copy link
Member

mvdbeek commented Dec 16, 2024

adds artifacts and noise to the repo that require keeping up to date?

yeah, that was my thinking

@mvdbeek mvdbeek merged commit 31c91b7 into galaxyproject:main Dec 16, 2024
1 check failed
@mvdbeek
Copy link
Member

mvdbeek commented Dec 16, 2024

Attention: deployment skipped!

https://github.com/galaxyproject/iwc/actions/runs/12353527351

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants