Skip to content

Commit

Permalink
ci: document the intended purpose of each workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
kmk3 committed Aug 19, 2023
1 parent cc323a6 commit 2703298
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build-extra.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Builds the project with alternative tools.

name: Build-extra

on:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Checks that `make dist` works and builds the project with the default
# configuration.

name: Build

# Note: Keep this list in sync with DISTFILES in ../../Makefile.
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/check-c.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Runs static analysis tools on the source code.

name: Check-C

on:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/check-profiles.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Lints and checks for errors in the profiles.

name: Check-Profiles

on:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/check-python.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Lints and checks for errors in Python files.

name: Check-Python

on:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Checks the spelling on all non-third-party files.

name: Codespell

on:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# checks that the tests are passing.

name: Test

on:
Expand Down

0 comments on commit 2703298

Please sign in to comment.