summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcyqsimon <28627918+cyqsimon@users.noreply.github.com>2023-09-19 17:46:53 +0800
committercyqsimon <28627918+cyqsimon@users.noreply.github.com>2023-09-19 17:50:25 +0800
commit1778dc11865142ff7c6eeccc5283cc172d8568ed (patch)
tree8e4b22cb8988e63be07d3558f2ec1af1703c4385
parentaccad5a6b05cd8512c952890dbd34b6595d12321 (diff)
Add comments in workflow definitions
-rw-r--r--.github/workflows/publish-crate.yaml6
-rw-r--r--.github/workflows/release.yaml5
2 files changed, 9 insertions, 2 deletions
diff --git a/.github/workflows/publish-crate.yaml b/.github/workflows/publish-crate.yaml
index 048ecc2..e110cfa 100644
--- a/.github/workflows/publish-crate.yaml
+++ b/.github/workflows/publish-crate.yaml
@@ -1,3 +1,9 @@
+# This workflow triggers when a stable release is published on GitHub.
+#
+# The crates.io token used for publishing was created under the account of
+# cyqsimon <28627918+cyqsimon@users.noreply.github.com> and was added to this
+# repository's secrets by Aram Drevekenin <aram@poor.dev>.
+
name: publish-crate
on:
release:
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index d205d30..8fcd326 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -8,10 +8,11 @@
# the release executables for each supported platform and attaches them
# as release assets to the previously created release.
#
-# The key here is that we create the release only once.
-#
# Reference:
# - https://eugene-babichenko.github.io/blog/2020/05/09/github-actions-cross-platform-auto-releases/
+#
+# Currently this workflow only ever creates drafts; the draft should be checked
+# and then released manually.
name: release
on: