ci: add some documentation in the workflow files

ClementTsang · Oct 18, 2021 · 4b49dda · 4b49dda
1 parent a9b8083
commit 4b49dda
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git 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
@@ -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: