-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update action.yml * Update jq query * update for viash 0.9 * add matrix to output of ns list * update docs * fix description * add more actions * update action * update readme * remove functionality * remove variable * update action * update * fix action * fix action * fix ci * pin versions * fix action * fix ci * fix ci * fix ci * fix ci * fix ci * fix ci * fix ci * add matrix to output * fix ci * fix action * fix action * fix action * improve readability * fix action * clean up action * move update docker engine * remove viash hub deploy * arguments `components` and `workflows` were removed in favour for the `target_dir` argument. * uniformize documentation pages * add changelog * update docs * update changelog * update mentioned viash versions to v6 * fix platform description * fix indentation * update readme * simplify readme * fix check-concurrent-pr * fix fallback * add paste * fix flag * add entry to changelog
- Loading branch information
Showing
43 changed files
with
1,702 additions
and
585 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Set up some variables for consistency | ||
| QMD_FILES := $(shell find . -name "README.qmd") # Find all README.qmd files | ||
| MD_FILES := $(patsubst %.qmd,%.md,$(QMD_FILES)) # Corresponding MD filenames | ||
|
|
||
| # Default target: build all MD files | ||
| all: $(MD_FILES) | ||
|
|
||
| README.md: README.qmd | ||
| quarto render $< | ||
| %/README.md: %/README.qmd %/action.yml | ||
| quarto render $< | ||
|
|
||
| # Clean up generated MD files | ||
| clean: | ||
| rm -f $(MD_FILES) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,50 @@ | ||
| # Github Actions for Viash | ||
|
|
||
| This repository stores [Github Actions](https://github.com/features/actions) useful for building and publishing [Viash](https://viash.io) components: | ||
|
|
||
| 1. [viash-io/viash-actions/setup](setup) - Install Viash | ||
| 2. [viash-io/viash-actions/ns-list](ns-list) - List Viash components in a repository | ||
| 3. [viash-io/viash-actions/ns-build](ns-build) - Build a namespace from many viash config files | ||
| This repository stores Github Actions useful for building and publishing | ||
| [Viash](https://viash.io) components: | ||
|
|
||
| There are also a few actions that are commonly used in Viash projects: | ||
| 1. [`ns-build`](ns-build) - viash ns build | ||
| 2. [`ns-list`](ns-list) - viash ns list | ||
| 3. [`setup`](setup) - Setup Viash | ||
|
|
||
| 1. [viash-io/viash-actions/project/cache-and-sync-s3](project/cache-and-sync-s3) - Sync and cache an S3 bucket | ||
| 2. [viash-io/viash_actions/project/detect-changed-components](project/detect-changed-components) - Detect changed Viash components | ||
| There are also some actions that are commonly used in Viash projects: | ||
|
|
||
| We recommend using `v3` for your actions. | ||
| 1. [`project/build-target`](project/build-target) - Build target | ||
| directory | ||
| 2. [`project/detect-changed-components`](project/detect-changed-components) - | ||
| Detect components with changed files | ||
| 3. [`project/is-pr`](project/is-pr) - Is PR | ||
| 4. [`project/sync-and-cache-s3`](project/sync-and-cache-s3) - Sync and | ||
| cache an S3 bucket | ||
| 5. [`project/update-docker-engine`](project/update-docker-engine) - | ||
| Update Docker Engine | ||
|
|
||
| ## Release Management | ||
| Finally, there are some [Viash | ||
| Pro](https://www.data-intuitive.com/services/viashpro.html) actions: | ||
|
|
||
| 1. [`pro/build-nextflow-params`](pro/build-nextflow-params) - Build | ||
| parameter yaml | ||
| 2. [`pro/build-nextflow-schemas`](pro/build-nextflow-schemas) - Build | ||
| nf-tower schemas | ||
| 3. [`pro/generate-documentation-qmd`](pro/generate-documentation-qmd) - | ||
| Build and publish qmd | ||
|
|
||
| This repository uses [GitHub's recommended release management for actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions): | ||
| We recommend using `v6` for your actions. | ||
|
|
||
| ## Release Management | ||
|
|
||
| * GitHub releases with tags are used for updates on the actions. | ||
| * Semantic versioning is used, with major, minor and possibly patch release. | ||
| * Major versions (such as `v1`) will always point to the last minor or patch release for this major version. (when `v1.0.2` is out, `v1` will point to this update to). This means using `viash-io/viash-actions/setup@v1` in your workflow file will automatically get the updated versions. Using `viash-io/viash-actions/setup@v1.0.2` will pin a specific release. | ||
| * Major version changes (`v1` to `v2`) will often come with breaking changes, and workflows might require manual updates. | ||
| This repository uses [GitHub’s recommended release management for | ||
| actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions): | ||
|
|
||
| - GitHub releases with tags are used for updates on the actions. | ||
| - Semantic versioning is used, with major, minor and possibly patch | ||
| release. | ||
| - Major versions (such as `v1`) will always point to the last minor or | ||
| patch release for this major version. (when `v1.0.2` is out, `v1` will | ||
| point to this update to). This means using | ||
| `viash-io/viash-actions/setup@v1` in your workflow file will | ||
| automatically get the updated versions. Using | ||
| `viash-io/viash-actions/setup@v1.0.2` will pin a specific release. | ||
| - Major version changes (`v1` to `v2`) will often come with breaking | ||
| changes, and workflows might require manual updates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Github Actions for Viash | ||
| format: gfm | ||
| --- | ||
|
|
||
| ```{r} | ||
| #| include: false | ||
| library(tidyverse) | ||
| repo_name <- "viash-io/viash-actions" | ||
| latest_stable_version <- "v6" | ||
| actions <- tibble( | ||
| file = list.files(".", full.names = TRUE, recursive = TRUE, pattern = "action.yml"), | ||
| path = gsub("^\\./(.*)/action.yml$", "\\1", file), | ||
| action = map(file, yaml::read_yaml), | ||
| action_name = map_chr(action, "name"), | ||
| namespace = ifelse(grepl("/", path), gsub("/.*", "", path), ""), | ||
| str = paste0("1. [`", path, "`](", path, ") - ", action_name, "\n") | ||
| ) | ||
| ``` | ||
|
|
||
|
|
||
| This repository stores Github Actions useful for building and publishing [Viash](https://viash.io) components: | ||
|
|
||
| ```{r output="asis"} | ||
| #| echo: false | ||
| cat(actions %>% filter(namespace == "") %>% pull(str) %>% paste(collapse = "")) | ||
| ``` | ||
|
|
||
| There are also some actions that are commonly used in Viash projects: | ||
|
|
||
| ```{r output="asis"} | ||
| #| echo: false | ||
| cat(actions %>% filter(namespace == "project") %>% pull(str) %>% paste(collapse = "")) | ||
| ``` | ||
|
|
||
| Finally, there are some [Viash Pro](https://www.data-intuitive.com/services/viashpro.html) actions: | ||
|
|
||
| ```{r output="asis"} | ||
| #| echo: false | ||
| cat(actions %>% filter(namespace == "pro") %>% pull(str) %>% paste(collapse = "")) | ||
| ``` | ||
|
|
||
| We recommend using ``r latest_stable_version`` for your actions. | ||
|
|
||
| ## Release Management | ||
|
|
||
| This repository uses [GitHub's recommended release management for actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions): | ||
|
|
||
| * GitHub releases with tags are used for updates on the actions. | ||
| * Semantic versioning is used, with major, minor and possibly patch release. | ||
| * Major versions (such as `v1`) will always point to the last minor or patch release for this major version. (when `v1.0.2` is out, `v1` will point to this update to). This means using `viash-io/viash-actions/setup@v1` in your workflow file will automatically get the updated versions. Using `viash-io/viash-actions/setup@v1.0.2` will pin a specific release. | ||
| * Major version changes (`v1` to `v2`) will often come with breaking changes, and workflows might require manual updates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.