Skip to content

Commit

Permalink
Modify when Test, Primer, and Documentation Build run (#2226)
Browse files Browse the repository at this point in the history
- Test and Primer don't run for documentation only changes since it's
  unnecessary, eating unnecessary cycles and slowing down CI since these
  workflows eat up the 20 max workers limit quite easily!

- Documentation Build runs all of the time now since quite a bit of the
  content depends on Black's code so even a simple 1-file change in
  src/black/__init__.py may break the docs build. It's not like this is
  a costly workflow anyway.

Fuzz is still running on all changes because with fuzzing, the more the
better in general. 6 or 7 jobs on a documentation only commit is much
better than 27/28 jobs anyway :p

I also found an error in our bug report issue template :)
  • Loading branch information
ichard26 committed May 13, 2021
1 parent b2ee211 commit 3ef339b
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Expand Up @@ -30,7 +30,7 @@ assignees: ""
- clone this repository;
- run `pip install -e .[d,python2]`;
- run `pip install -r test_requirements.txt`
- make sure it's sane by running `python -m unittest`; and
- make sure it's sane by running `python -m pytest`; and
- run `black` like you did last time.

**Additional context** Add any other context about the problem here.
16 changes: 1 addition & 15 deletions .github/workflows/doc.yml
@@ -1,20 +1,6 @@
name: Documentation Build

on:
push:
paths:
- "docs/**"
- "README.md"
- "CHANGES.md"
- "CONTRIBUTING.md"
- "AUTHORS.md"
pull_request:
paths:
- "docs/**"
- "README.md"
- "CHANGES.md"
- "CONTRIBUTING.md"
- "AUTHORS.md"
on: [push, pull_request]

jobs:
build:
Expand Down
11 changes: 10 additions & 1 deletion .github/workflows/primer.yml
@@ -1,6 +1,15 @@
name: Primer

on: [push, pull_request]
on:
push:
paths-ignore:
- "docs/**"
- "*.md"

pull_request:
paths-ignore:
- "docs/**"
- "*.md"

jobs:
build:
Expand Down
11 changes: 10 additions & 1 deletion .github/workflows/test.yml
@@ -1,6 +1,15 @@
name: Test

on: [push, pull_request]
on:
push:
paths-ignore:
- "docs/**"
- "*.md"

pull_request:
paths-ignore:
- "docs/**"
- "*.md"

jobs:
build:
Expand Down

0 comments on commit 3ef339b

Please sign in to comment.