diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml index b3bcd50..0365a4d 100644 --- a/.github/workflows/docs_test_action.yml +++ b/.github/workflows/docs_test_action.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Install and Build 🔧 uses: sphinx-toolbox/sphinx-action@sphinx-3.3.1-py39 diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index 1ecb7b9..1f5be86 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -19,10 +19,10 @@ jobs: steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Check for changed files - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" @@ -32,7 +32,7 @@ jobs: - name: Setup Python 🐍 if: steps.changes.outputs.code == 'true' - uses: "actions/setup-python@v5" + uses: "actions/setup-python@v6" with: python-version: "3.9" diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index b889816..2b5e4f8 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -24,10 +24,10 @@ jobs: steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Check for changed files - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" @@ -37,7 +37,7 @@ jobs: - name: Setup Python 🐍 if: steps.changes.outputs.code == 'true' - uses: "actions/setup-python@v5" + uses: "actions/setup-python@v6" with: python-version: "3.9" diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml index 8e80d72..fa2aa04 100644 --- a/.github/workflows/python_ci.yml +++ b/.github/workflows/python_ci.yml @@ -30,11 +30,11 @@ jobs: steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" @@ -45,7 +45,7 @@ jobs: - name: Setup Python 🐍 id: setup-python if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }} - uses: "actions/setup-python@v5" + uses: "actions/setup-python@v6" with: python-version: "${{ matrix.config.python-version }}" diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml index 60dad29..3afec52 100644 --- a/.github/workflows/python_ci_linux.yml +++ b/.github/workflows/python_ci_linux.yml @@ -31,11 +31,11 @@ jobs: steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" @@ -46,7 +46,7 @@ jobs: - name: Setup Python 🐍 id: setup-python if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }} - uses: "actions/setup-python@v5" + uses: "actions/setup-python@v6" with: python-version: "${{ matrix.config.python-version }}" diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml index 55faf55..2f7d7a7 100644 --- a/.github/workflows/python_ci_macos.yml +++ b/.github/workflows/python_ci_macos.yml @@ -30,11 +30,11 @@ jobs: steps: - name: Checkout 🛎️ - uses: "actions/checkout@v4" + uses: "actions/checkout@v6" - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" @@ -45,7 +45,7 @@ jobs: - name: Setup Python 🐍 id: setup-python if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }} - uses: "actions/setup-python@v5" + uses: "actions/setup-python@v6" with: python-version: "${{ matrix.config.python-version }}" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ee9683d..7d6b493 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,6 +5,7 @@ exclude: ^$ ci: autoupdate_schedule: quarterly + skip: [taplo-lint] repos: - repo: https://github.com/repo-helper/pyproject-parser @@ -21,7 +22,6 @@ repos: - id: check-case-conflict - id: check-executables-have-shebangs - id: check-json - - id: check-toml - id: check-yaml - id: check-merge-conflict - id: check-symlinks @@ -31,8 +31,14 @@ repos: - id: mixed-line-ending - id: end-of-file-fixer + - repo: https://github.com/domdfcoding/taplo-pre-commit + rev: v0.10.0 + hooks: + - id: taplo-lint + args: [] + - repo: https://github.com/domdfcoding/pre-commit-hooks - rev: v0.6.0 + rev: v0.7.0 hooks: - id: requirements-txt-sorter args: @@ -40,6 +46,9 @@ repos: - id: check-docstring-first exclude: ^(doc-source/conf|__pkginfo__|setup|tests/.*)\.py$ - id: bind-requirements + args: + - --python-min + - '3.8' - repo: https://github.com/python-formate/flake8-dunder-all rev: v0.5.0 @@ -80,7 +89,7 @@ repos: - id: snippet-fmt - repo: https://github.com/python-formate/formate - rev: v1.2.0 + rev: v1.2.1 hooks: - id: formate exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$ diff --git a/README.rst b/README.rst index 065ba60..9d1d43f 100644 --- a/README.rst +++ b/README.rst @@ -4,8 +4,8 @@ Contributing Guide .. start short_desc -**Contributing guide for repo-helper and associated projects** +**Contributing guide for projects in the python-formate organization** .. end short_desc -View online at https://contributing.repo-helper.uk +View online at https://contributing-to-formate.readthedocs.io/ diff --git a/contributing/__init__.py b/contributing/__init__.py index 50b7374..73c78c4 100644 --- a/contributing/__init__.py +++ b/contributing/__init__.py @@ -2,7 +2,7 @@ # # __init__.py """ -Contributing guide for repo-helper and associated projects. +Contributing guide for projects in the python-formate organization. """ # # Copyright © 2020-2021 Dominic Davis-Foster diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html index b101b24..ffdc5ad 100644 --- a/doc-source/_templates/base.html +++ b/doc-source/_templates/base.html @@ -2,4 +2,5 @@ {% extends "!base.html" %} {% block extrahead %} + {% endblock %} diff --git a/doc-source/conf.py b/doc-source/conf.py index 1b1e520..b30076c 100644 --- a/doc-source/conf.py +++ b/doc-source/conf.py @@ -102,4 +102,5 @@ def setup(app): nitpicky = True del version del release -html_title = "repo-helper Contributing Guide" +html_title = "formate Contributing Guide" +html_logo = "formate.png" diff --git a/doc-source/formate.png b/doc-source/formate.png new file mode 100644 index 0000000..02d7f8d Binary files /dev/null and b/doc-source/formate.png differ diff --git a/doc-source/getting-started.rst b/doc-source/getting-started.rst index 052b182..24d2053 100644 --- a/doc-source/getting-started.rst +++ b/doc-source/getting-started.rst @@ -49,7 +49,7 @@ With bash: .. code-block:: bash - (repo-helper) $ + (formate) $ .. _GitHub: https://github.com/ diff --git a/justfile b/justfile index 9cd8b78..4307956 100644 --- a/justfile +++ b/justfile @@ -23,3 +23,8 @@ bare-ignore: lint: unused-imports incomplete-defs bare-ignore tox -n qa + +uncomm: + git status -uall --ignored + +# Custom commands can be added below this comment diff --git a/pyproject.toml b/pyproject.toml index 16db69b..0eaa546 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "whey" [project] name = "contributing" version = "2021.0.0" -description = "Contributing guide for repo-helper and associated projects" +description = "Contributing guide for projects in the python-formate organization" readme = "README.rst" keywords = [] dynamic = [ "requires-python", "classifiers", "dependencies",] @@ -18,10 +18,10 @@ name = "Dominic Davis-Foster" email = "dominic@davis-foster.co.uk" [project.urls] -Homepage = "https://github.com/repo-helper/contributing" -"Issue Tracker" = "https://github.com/repo-helper/contributing/issues" -"Source Code" = "https://github.com/repo-helper/contributing" -Documentation = "https://contributing.repo-helper.uk" +Homepage = "https://github.com/python-formate/contributing" +"Issue Tracker" = "https://github.com/python-formate/contributing/issues" +"Source Code" = "https://github.com/python-formate/contributing" +Documentation = "https://contributing-to-formate.readthedocs.io" [tool.whey] base-classifiers = [] @@ -33,7 +33,7 @@ license-key = "MIT" [tool.importcheck] [tool.sphinx-pyproject] -github_username = "repo-helper" +github_username = "python-formate" github_repository = "contributing" author = "Dominic Davis-Foster" project = "contributing" diff --git a/repo_helper.yml b/repo_helper.yml index 902445b..4e2b1b4 100644 --- a/repo_helper.yml +++ b/repo_helper.yml @@ -4,11 +4,11 @@ modname: 'contributing' copyright_years: '2020-2021' author: 'Dominic Davis-Foster' email: 'dominic@davis-foster.co.uk' -username: 'repo-helper' +username: 'python-formate' assignee: 'domdfcoding' version: '2021.0.0' license: 'MIT' -short_desc: 'Contributing guide for repo-helper and associated projects' +short_desc: 'Contributing guide for projects in the python-formate organization' use_whey: True docs_fail_on_warning: true @@ -16,7 +16,7 @@ sphinx_html_theme: furo enable_tests: false enable_conda: false on_pypi: false -docs_url: https://contributing.repo-helper.uk +docs_url: https://contributing-to-formate.readthedocs.io python_versions: - '3.8' @@ -25,7 +25,8 @@ sphinx_conf_epilogue: - nitpicky = True - del version - del release - - html_title = "repo-helper Contributing Guide" + - html_title = "formate Contributing Guide" + - html_logo = "formate.png" extra_sphinx_extensions: - html_section @@ -34,3 +35,5 @@ exclude_files: - contributing - Source_rst - license_rst + +preserve_custom_theme: true diff --git a/tox.ini b/tox.ini index 2465dcb..9f1b726 100644 --- a/tox.ini +++ b/tox.ini @@ -37,6 +37,7 @@ setenv = PYTHONDEVMODE=1 PIP_DISABLE_PIP_VERSION_CHECK=1 SETUPTOOLS_USE_DISTUTILS=stdlib +download = True deps = importcheck>=0.1.0 commands = python --version