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 README for github workflows directory #739

Merged

Conversation

sjspielman
Copy link
Member

Closes #738

This PR adds documentation for the files in .github/workflows/. Any feedback welcome, including whether a different readme format (e.g. a table instead of a list?) would be preferred.

@sjspielman sjspielman requested review from jashapiro and removed request for jaclyn-taroni August 30, 2024 16:50
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a few minor changes.

Comment on lines +9 to +12
## Module testing

* Each workflow `run_{module name}.yml` is used to run the given module in CI using the test data.
* `run_all-modules.yml` runs all modules in CI by calling each `run_{module name}.yml` workflow.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put this first, as we want to do this for all modules, but Docker comes later.

.github/workflows/README.md Outdated Show resolved Hide resolved
@sjspielman
Copy link
Member Author

Noting I canceled the cell-type-ewings Docker workflow. Since there wasn't actually a code change here, this action doesn't need to run here.

@sjspielman sjspielman merged commit 402371e into AlexsLemonade:main Aug 30, 2024
3 of 4 checks passed
@sjspielman sjspielman deleted the sjspielman/738-workflow-readme branch August 30, 2024 17:15
@sjspielman sjspielman restored the sjspielman/738-workflow-readme branch August 30, 2024 17:15
@sjspielman sjspielman deleted the sjspielman/738-workflow-readme branch August 30, 2024 17:15
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.

Add README to the workflows directory
2 participants