Skip to content

Commit 51bc9a6

Browse files
Updated files with 'repo_helper'. (#20)
Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>
1 parent 84499fe commit 51bc9a6

File tree

14 files changed

+229
-119
lines changed

14 files changed

+229
-119
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If possible, please include a small, self-contained reproduction.
4444
* tox-recreate-hook:
4545

4646
## Installation source
47-
<!-- e.g. Github repository, Github Releases, PyPI/pip, Anaconda/conda -->
47+
<!-- e.g. GitHub repository, GitHub Releases, PyPI/pip, Anaconda/conda -->
4848

4949

5050
## Other Additional Information:

.github/workflows/docs_test_action.yml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,29 @@ name: "Docs Check"
44
on:
55
- push
66

7+
permissions:
8+
contents: read
9+
710
jobs:
811
docs:
912
runs-on: ubuntu-latest
1013
steps:
1114
- name: Checkout 🛎️
1215
uses: "actions/checkout@v1"
16+
17+
- name: Check for changed files
18+
uses: dorny/paths-filter@v2
19+
id: changes
20+
with:
21+
list-files: "json"
22+
filters: |
23+
code:
24+
- '!tests/**'
25+
1326
- name: Install and Build 🔧
14-
uses: ammaraskar/sphinx-action@master
27+
uses: sphinx-toolbox/[email protected]
28+
if: steps.changes.outputs.code == 'true'
1529
with:
16-
pre-build-command: apt-get update && apt-get install gcc python3-dev git pandoc -y && python -m pip install tox
30+
pre-build-command: python -m pip install tox
1731
docs-folder: "doc-source/"
1832
build-command: "tox -e docs -- -W "

.github/workflows/flake8.yml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ name: Flake8
55
on:
66
push:
77

8+
permissions:
9+
contents: read
10+
811
jobs:
912
Run:
1013
name: "Flake8"
@@ -14,17 +17,29 @@ jobs:
1417
- name: Checkout 🛎️
1518
uses: "actions/checkout@v2"
1619

20+
- name: Check for changed files
21+
uses: dorny/paths-filter@v2
22+
id: changes
23+
with:
24+
list-files: "json"
25+
filters: |
26+
code:
27+
- '!(doc-source/**|CONTRIBUTING.rst|.imgbotconfig|.pre-commit-config.yaml|.pylintrc|.readthedocs.yml)'
28+
1729
- name: Setup Python 🐍
30+
if: steps.changes.outputs.code == 'true'
1831
uses: "actions/setup-python@v2"
1932
with:
20-
python-version: "3.8"
33+
python-version: "3.7"
2134

2235
- name: Install dependencies 🔧
36+
if: steps.changes.outputs.code == 'true'
2337
run: |
2438
python -VV
2539
python -m site
2640
python -m pip install --upgrade pip setuptools wheel
2741
python -m pip install tox
2842
2943
- name: "Run Flake8"
30-
run: "python -m tox -e lint -- --format github"
44+
if: steps.changes.outputs.code == 'true'
45+
run: "python -m tox -e lint -s false -- --format github"

.github/workflows/mypy.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ name: mypy
55
on:
66
push:
77

8+
permissions:
9+
contents: read
10+
811
jobs:
912
Run:
1013
name: "mypy / ${{ matrix.os }}"
@@ -19,7 +22,17 @@ jobs:
1922
- name: Checkout 🛎️
2023
uses: "actions/checkout@v2"
2124

25+
- name: Check for changed files
26+
uses: dorny/paths-filter@v2
27+
id: changes
28+
with:
29+
list-files: "json"
30+
filters: |
31+
code:
32+
- '!(doc-source/**|CONTRIBUTING.rst|.imgbotconfig|.pre-commit-config.yaml|.pylintrc|.readthedocs.yml)'
33+
2234
- name: Setup Python 🐍
35+
if: steps.changes.outputs.code == 'true'
2336
uses: "actions/setup-python@v2"
2437
with:
2538
python-version: "3.7"
@@ -32,4 +45,5 @@ jobs:
3245
python -m pip install --upgrade tox virtualenv
3346
3447
- name: "Run mypy"
35-
run: "python -m tox -e mypy"
48+
if: steps.changes.outputs.code == 'true'
49+
run: "python -m tox -e mypy -s false"

.github/workflows/python_ci.yml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ name: Windows
55
on:
66
push:
77

8+
permissions:
9+
actions: write
10+
contents: read
11+
812
jobs:
913
tests:
1014
name: "windows-2019 / Python ${{ matrix.config.python-version }}"
1115
runs-on: "windows-2019"
1216
continue-on-error: ${{ matrix.config.experimental }}
1317
env:
14-
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-alpha.7'
18+
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-beta.1'
1519

1620
strategy:
1721
fail-fast: False
@@ -20,30 +24,44 @@ jobs:
2024
- {python-version: "3.7", testenvs: "py37,build", experimental: False}
2125
- {python-version: "3.8", testenvs: "py38,build", experimental: False}
2226
- {python-version: "3.9", testenvs: "py39,build", experimental: False}
23-
- {python-version: "3.10.0-alpha.7", testenvs: "py310-dev,build", experimental: True}
27+
- {python-version: "3.10.0-beta.1", testenvs: "py310-dev,build", experimental: True}
2428

2529
steps:
2630
- name: Checkout 🛎️
2731
uses: "actions/checkout@v2"
2832

33+
- name: Check for changed files
34+
if: startsWith(github.ref, 'refs/tags/') != true
35+
uses: dorny/paths-filter@v2
36+
id: changes
37+
with:
38+
list-files: "json"
39+
filters: |
40+
code:
41+
- '!(doc-source/**|CONTRIBUTING.rst|.imgbotconfig|.pre-commit-config.yaml|.pylintrc|.readthedocs.yml)'
42+
2943
- name: Setup Python 🐍
44+
id: setup-python
45+
if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
3046
uses: "actions/setup-python@v2"
3147
with:
3248
python-version: "${{ matrix.config.python-version }}"
3349

3450
- name: Install dependencies 🔧
51+
if: steps.setup-python.outcome == 'success'
3552
run: |
3653
python -VV
3754
python -m site
3855
python -m pip install --upgrade pip setuptools wheel
3956
python -m pip install --upgrade tox virtualenv
4057
4158
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
42-
run: python -m tox -e "${{ matrix.config.testenvs }}"
59+
if: steps.setup-python.outcome == 'success'
60+
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
4361

4462
- name: "Upload Coverage 🚀"
4563
uses: actions/upload-artifact@v2
46-
if: ${{ always() }}
64+
if: ${{ always() && steps.setup-python.outcome == 'success' }}
4765
with:
4866
name: "coverage-${{ matrix.config.python-version }}"
4967
path: .coverage

.github/workflows/python_ci_linux.yml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ name: Linux
55
on:
66
push:
77

8+
permissions:
9+
actions: write
10+
contents: read
11+
812
jobs:
913
tests:
1014
name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}"
1115
runs-on: "ubuntu-20.04"
1216
continue-on-error: ${{ matrix.config.experimental }}
1317
env:
14-
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-alpha.7'
18+
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-beta.1'
1519

1620
strategy:
1721
fail-fast: False
@@ -20,18 +24,31 @@ jobs:
2024
- {python-version: "3.7", testenvs: "py37,build", experimental: False}
2125
- {python-version: "3.8", testenvs: "py38,build", experimental: False}
2226
- {python-version: "3.9", testenvs: "py39,build", experimental: False}
23-
- {python-version: "3.10.0-alpha.7", testenvs: "py310-dev,build", experimental: True}
27+
- {python-version: "3.10.0-beta.1", testenvs: "py310-dev,build", experimental: True}
2428

2529
steps:
2630
- name: Checkout 🛎️
2731
uses: "actions/checkout@v2"
2832

33+
- name: Check for changed files
34+
if: startsWith(github.ref, 'refs/tags/') != true
35+
uses: dorny/paths-filter@v2
36+
id: changes
37+
with:
38+
list-files: "json"
39+
filters: |
40+
code:
41+
- '!(doc-source/**|CONTRIBUTING.rst|.imgbotconfig|.pre-commit-config.yaml|.pylintrc|.readthedocs.yml)'
42+
2943
- name: Setup Python 🐍
44+
id: setup-python
45+
if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
3046
uses: "actions/setup-python@v2"
3147
with:
3248
python-version: "${{ matrix.config.python-version }}"
3349

3450
- name: Install dependencies 🔧
51+
if: steps.setup-python.outcome == 'success'
3552
run: |
3653
python -VV
3754
python -m site
@@ -40,11 +57,12 @@ jobs:
4057
python -m pip install --upgrade coverage_pyver_pragma
4158
4259
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
43-
run: python -m tox -e "${{ matrix.config.testenvs }}"
60+
if: steps.setup-python.outcome == 'success'
61+
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
4462

4563
- name: "Upload Coverage 🚀"
4664
uses: actions/upload-artifact@v2
47-
if: ${{ always() }}
65+
if: ${{ always() && steps.setup-python.outcome == 'success' }}
4866
with:
4967
name: "coverage-${{ matrix.config.python-version }}"
5068
path: .coverage

.github/workflows/python_ci_macos.yml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ name: macOS
55
on:
66
push:
77

8+
permissions:
9+
actions: write
10+
contents: read
11+
812
jobs:
913
tests:
1014
name: "macos-latest / Python ${{ matrix.config.python-version }}"
1115
runs-on: "macos-latest"
1216
continue-on-error: ${{ matrix.config.experimental }}
1317
env:
14-
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-alpha.7'
18+
USING_COVERAGE: '3.7,3.8,3.9,3.10.0-beta.1'
1519

1620
strategy:
1721
fail-fast: False
@@ -20,30 +24,44 @@ jobs:
2024
- {python-version: "3.7", testenvs: "py37,build", experimental: False}
2125
- {python-version: "3.8", testenvs: "py38,build", experimental: False}
2226
- {python-version: "3.9", testenvs: "py39,build", experimental: False}
23-
- {python-version: "3.10.0-alpha.7", testenvs: "py310-dev,build", experimental: True}
27+
- {python-version: "3.10.0-beta.1", testenvs: "py310-dev,build", experimental: True}
2428

2529
steps:
2630
- name: Checkout 🛎️
2731
uses: "actions/checkout@v2"
2832

33+
- name: Check for changed files
34+
if: startsWith(github.ref, 'refs/tags/') != true
35+
uses: dorny/paths-filter@v2
36+
id: changes
37+
with:
38+
list-files: "json"
39+
filters: |
40+
code:
41+
- '!(doc-source/**|CONTRIBUTING.rst|.imgbotconfig|.pre-commit-config.yaml|.pylintrc|.readthedocs.yml)'
42+
2943
- name: Setup Python 🐍
44+
id: setup-python
45+
if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
3046
uses: "actions/setup-python@v2"
3147
with:
3248
python-version: "${{ matrix.config.python-version }}"
3349

3450
- name: Install dependencies 🔧
51+
if: steps.setup-python.outcome == 'success'
3552
run: |
3653
python -VV
3754
python -m site
3855
python -m pip install --upgrade pip setuptools wheel
3956
python -m pip install --upgrade tox virtualenv
4057
4158
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
42-
run: python -m tox -e "${{ matrix.config.testenvs }}"
59+
if: steps.setup-python.outcome == 'success'
60+
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
4361

4462
- name: "Upload Coverage 🚀"
4563
uses: actions/upload-artifact@v2
46-
if: ${{ always() }}
64+
if: ${{ always() && steps.setup-python.outcome == 'success' }}
4765
with:
4866
name: "coverage-${{ matrix.config.python-version }}"
4967
path: .coverage

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ repos:
6262
- --keep-runtime-typing
6363

6464
- repo: https://github.com/Lucas-C/pre-commit-hooks
65-
rev: v1.1.9
65+
rev: v1.1.10
6666
hooks:
6767
- id: remove-crlf
6868
- id: forbid-crlf
6969

7070
- repo: https://github.com/repo-helper/formate
71-
rev: v0.4.3
71+
rev: v0.4.4
7272
hooks:
7373
- id: formate
7474
exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$

doc-source/Source.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,27 @@ and can be accessed from the following URL: https://github.com/python-coincidenc
77

88
If you have ``git`` installed, you can clone the repository with the following command:
99

10-
.. code-block:: bash
10+
.. prompt:: bash
11+
12+
git clone https://github.com/python-coincidence/tox-recreate-hook
13+
14+
.. parsed-literal::
1115
12-
$ git clone https://github.com/python-coincidence/tox-recreate-hook"
13-
> Cloning into 'tox-recreate-hook'...
14-
> remote: Enumerating objects: 47, done.
15-
> remote: Counting objects: 100% (47/47), done.
16-
> remote: Compressing objects: 100% (41/41), done.
17-
> remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
18-
> Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
19-
> Resolving deltas: 100% (66/66), done.
16+
Cloning into 'tox-recreate-hook'...
17+
remote: Enumerating objects: 47, done.
18+
remote: Counting objects: 100% (47/47), done.
19+
remote: Compressing objects: 100% (41/41), done.
20+
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
21+
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
22+
Resolving deltas: 100% (66/66), done.
2023
2124
| Alternatively, the code can be downloaded in a 'zip' file by clicking:
2225
| :guilabel:`Clone or download` --> :guilabel:`Download Zip`
2326
2427
.. figure:: git_download.png
25-
:alt: Downloading a 'zip' file of the source code.
28+
:alt: Downloading a 'zip' file of the source code.
2629

27-
Downloading a 'zip' file of the source code
30+
Downloading a 'zip' file of the source code
2831

2932

3033
Building from source

0 commit comments

Comments
 (0)