Skip to content

Commit ac8216c

Browse files
authored
docs: added comment to GitHub actions yaml (#20)
1 parent acf8b3f commit ac8216c

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

.github/workflows/continuous-integration.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1+
# Github Actions workflow syntax documentation:
2+
# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
3+
#
4+
# Useful Github Actions Triggers reference:
5+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-a-custom-action#triggers
6+
7+
18
name: "Continuous Integration"
29

3-
on: [push, pull_request]
10+
on: [push, pull_request] # run unit tests on each commit so developers can notice errors as early as possible
411

512
jobs:
613
test:
714
name: Unit tests
815
runs-on: ubuntu-latest
916
timeout-minutes: 10
1017
strategy:
11-
matrix:
18+
matrix: # matrix testing strategy
1219
python-version: ['3.7', '3.8', '3.9', '3.10']
1320
steps:
1421
- name: Check out repository code

0 commit comments

Comments
 (0)