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
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This directory contains GitHub Actions (GHA) yaml files as well as helper files they use.

## Building and pushing Docker images

* Each workflow `docker_{module name}.yml` is used to build the given module's Docker image.
* `docker_all-modules.yml` builds and pushes all module Docker images by calling each `docker_{module name}.yml` workflow.
* The `build-push-docker-module.yml` workflow is not standlone but contains actions used by `docker_all-modules.yml` and each `docker_{module name}.yml`.
sjspielman marked this conversation as resolved.
Show resolved Hide resolved

## 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.
Comment on lines +3 to +6
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.


## Creating releases

* `file-periodic-release-issues.yml` files issues to prepare for a periodic (dated) release.
* `create-periodic-release.yml` creates a periodic (dated) release.

## Repository maintenance

* `spellcheck.yml` performs spell checking of markdown and R Markdown documents.
* `code-styling.yml` performs code styling using `styler` and `ruff`.
* This workflow also consumes `modules_code-styling.txt` to determine which modules to style.
When modules reach the development stage where they should be automatically styled, they should be added to this text file.
Loading