From 53f3a817d568130797557913ce350dfecc3ec9f5 Mon Sep 17 00:00:00 2001 From: "Stephanie J. Spielman" Date: Fri, 30 Aug 2024 12:48:48 -0400 Subject: [PATCH 1/5] add readme for workflow directory --- .github/workflows/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/README.md diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 000000000..649155faf --- /dev/null +++ b/.github/workflows/README.md @@ -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`. + +## 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. + +## 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. From 623131a73910743747360a9e8bb5356a680e09a9 Mon Sep 17 00:00:00 2001 From: "Stephanie J. Spielman" Date: Fri, 30 Aug 2024 12:49:55 -0400 Subject: [PATCH 2/5] recreational rename --- .../{docker_cell-type-ewings.yaml => docker_cell-type-ewings.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{docker_cell-type-ewings.yaml => docker_cell-type-ewings.yml} (100%) diff --git a/.github/workflows/docker_cell-type-ewings.yaml b/.github/workflows/docker_cell-type-ewings.yml similarity index 100% rename from .github/workflows/docker_cell-type-ewings.yaml rename to .github/workflows/docker_cell-type-ewings.yml From 542c0fa44df3ecab867ce742d9086df12dcd4f11 Mon Sep 17 00:00:00 2001 From: Stephanie Spielman Date: Fri, 30 Aug 2024 13:08:10 -0400 Subject: [PATCH 3/5] Update .github/workflows/README.md Co-authored-by: Joshua Shapiro --- .github/workflows/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 649155faf..f78341dc6 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -4,7 +4,7 @@ This directory contains GitHub Actions (GHA) yaml files as well as helper files * 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`. +* The `build-push-docker-module.yml` workflow contains actions used by `docker_all-modules.yml` and each `docker_{module name}.yml`. It is not meant to be run as a standalone action. ## Module testing From 32432c3cb68cc49ac7d7b7d4de4588aad58eba05 Mon Sep 17 00:00:00 2001 From: "Stephanie J. Spielman" Date: Fri, 30 Aug 2024 13:08:43 -0400 Subject: [PATCH 4/5] ospl --- .github/workflows/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index f78341dc6..3c2ad1769 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -4,7 +4,8 @@ This directory contains GitHub Actions (GHA) yaml files as well as helper files * 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 contains actions used by `docker_all-modules.yml` and each `docker_{module name}.yml`. It is not meant to be run as a standalone action. +* The `build-push-docker-module.yml` workflow contains actions used by `docker_all-modules.yml` and each `docker_{module name}.yml`. +It is not meant to be run as a standalone action. ## Module testing From b4841906cb47f3ce6a03089b4450b4fecd31afa4 Mon Sep 17 00:00:00 2001 From: "Stephanie J. Spielman" Date: Fri, 30 Aug 2024 13:09:39 -0400 Subject: [PATCH 5/5] module testing first, and naming --- .github/workflows/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 3c2ad1769..c5bc31db4 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,5 +1,10 @@ This directory contains GitHub Actions (GHA) yaml files as well as helper files they use. +## 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. + ## Building and pushing Docker images * Each workflow `docker_{module name}.yml` is used to build the given module's Docker image. @@ -7,15 +12,10 @@ This directory contains GitHub Actions (GHA) yaml files as well as helper files * The `build-push-docker-module.yml` workflow contains actions used by `docker_all-modules.yml` and each `docker_{module name}.yml`. It is not meant to be run as a standalone action. -## 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. - ## 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. +* `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