Skip to content

Commit 3f3f201

Browse files
[DOCUMENTATION] Added Comments to CI (- WIP #209 -)
Changes in file .github/workflows/Tests.yml: - added much needed comments for the massive CI workflow.
1 parent 0c134bf commit 3f3f201

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

.github/workflows/Tests.yml

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
---
22
name: CI
3+
# Continuous Integration workflow for building, testing, and validating the project
4+
#
5+
# Jobs included:
6+
# - BUILD: Ensures the project compiles correctly
7+
# - BOOTSTRAP: Tests installation across Python versions and locales
8+
# - MATS: Runs Machine Acceptance Tests
9+
# - COVERAGE: Generates coverage reports on multiple OS and Python versions
10+
# - STYLE: Checks code style and linting compliance
11+
# - INTEGRATION: Performs integration tests on different platforms
12+
# - EXTRAS-FOR-SETUP: Tests legacy setup scripts
13+
# - EXTRAS-FOR-PIP: Validates package dependencies and pip installations
14+
# - DOCS: Builds and lints documentation
15+
# - TOX: Executes tests across Python environments using Tox
16+
#
17+
# Required Secrets:
18+
# - CODECOV_TOKEN: For uploading coverage reports to Codecov
19+
# - CODECLIMATE_TOKEN: For integration with Code Climate
20+
# - CC_TEST_REPORTER_ID: For Code Climate test reporting
21+
322
on: # yamllint disable-line rule:truthy
423
push:
524
branches:
@@ -600,7 +619,7 @@ jobs:
600619
PYTHON_VERSION: ${{ matrix.python-version }}
601620
LANG: "en_US.utf-8"
602621
LC_CTYPE: "en_US.utf-8"
603-
DOCS_BUILD_REF: ${{ github.sha }}
622+
DOCS_BUILD_REF: ${{ github.sha }} # Reference the specific commit in documentation builds
604623
steps:
605624
- uses: actions/checkout@v4
606625
- name: Set up Python ${{ matrix.python-version }}

0 commit comments

Comments
 (0)