Skip to content

CI: exclude linting dependencies from the unittest environment. #8861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jul 22, 2023
Merged

CI: exclude linting dependencies from the unittest environment. #8861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7c63128
CI: exclude linting dependencies from the unittest environment.
mbyrnepr2 Jul 18, 2023
616bc59
Revert tox version bump.
mbyrnepr2 Jul 20, 2023
986a5e0
Revert "Revert tox version bump."
mbyrnepr2 Jul 20, 2023
d78790e
CI: Remove redundant tox install step.
mbyrnepr2 Jul 20, 2023
35f6006
Testing: Modify requirements_test.txt to invalidate cache.
mbyrnepr2 Jul 20, 2023
29a0e0a
CI testing: Invalidate cache.
mbyrnepr2 Jul 20, 2023
c6de6ba
Finding tox: activate venv.
mbyrnepr2 Jul 20, 2023
712ffb8
invalidate cache to test.
mbyrnepr2 Jul 20, 2023
e7195aa
Revert to original version.
mbyrnepr2 Jul 20, 2023
78c46bd
Debugging CI.
mbyrnepr2 Jul 20, 2023
bd58ae9
Clone primer packages if not found in projects-cache (created on main…
mbyrnepr2 Jul 21, 2023
728d576
Update .github/workflows/primer_run_pr.yaml
mbyrnepr2 Jul 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ jobs:
python -m pip install -U pip setuptools wheel
pip install -U -r requirements_test.txt
pip install -U -r doc/requirements.txt
pip install pre-commit
- name: Generate pre-commit restore key
id: generate-pre-commit-key
run: >-
Expand Down Expand Up @@ -173,11 +174,9 @@ jobs:
key:
${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-base.outputs.python-key }}
- name: Install tox
Copy link
Member Author

@mbyrnepr2 mbyrnepr2 Jul 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This step wasn't necessary because tox is installed already via requirements_test.txt and it is available once the venv is activated.

run: |
pip install -U tox
- name: Run checks on documentation code examples
run: |
. venv/bin/activate
tox -e test_doc
- name: Check documentation build and links
run: |
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/primer_run_pr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ jobs:
key: >-
${{ runner.os }}-${{ matrix.python-version }}-${{
steps.commitstring.outputs.commitstring }}-primer
- name: Regenerate cache
if: steps.cache-projects.outputs.cache-hit != 'true'
run: |
. venv/bin/activate
python tests/primer/__main__.py prepare --clone
- name: Check cache
run: |
. venv/bin/activate
Expand Down
1 change: 0 additions & 1 deletion requirements_test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
-r requirements_test_pre_commit.txt
Copy link
Member Author

@mbyrnepr2 mbyrnepr2 Jul 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the purpose of requirements_test_pre_commit.txt is to invalidate the cache in the CI and install + test a new dependency if a user changes the file manually (or dependabot bumps it).
Apart from that, there is a separate job in the CI to run pre-commit and its dependencies are managed via .pre-commit-config.yml.

Copy link
Member

@jacobtylerwalls jacobtylerwalls Jul 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should update the last paragraph here about pre-commit installation to point out the need to install the pre-commit requirements?

-r requirements_test_min.txt
coverage~=7.2
tbump~=6.10.0
Expand Down