diff options
author | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-10-17 21:54:06 -0400 |
---|---|---|
committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-10-17 21:54:06 -0400 |
commit | 4b49ddabe5f9021b81430ec15a6d4939de9b3b9d (patch) | |
tree | 549928a03713ab1a3a5633ba163da5c5e54319e5 | |
parent | a9b808334c9f42c0f9f2d2548d7ec6c6de9a0c5a (diff) |
ci: add some documentation in the workflow files
-rw-r--r-- | .github/workflows/audit.yml | 2 | ||||
-rw-r--r-- | .github/workflows/post-release.yml | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml index 1a017bfb..6189d737 100644 --- a/.github/workflows/audit.yml +++ b/.github/workflows/audit.yml @@ -1,3 +1,5 @@ +# A routine check to see if there are any Rust-specific security vulnerabilities in the repo we should be aware of. + name: audit on: workflow_dispatch: diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml index 1cf2b907..5eed7cc4 100644 --- a/.github/workflows/post-release.yml +++ b/.github/workflows/post-release.yml @@ -1,4 +1,4 @@ -# Actions to run after releasing a version. +# Actions to run after releasing a version, like generating documentation via mkdocs or notifying packaging repos. name: post-release on: |