Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/docs_test_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/flake8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/mypy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/python_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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 }}"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/python_ci_linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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 }}"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/python_ci_macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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 }}"

Expand Down
15 changes: 12 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ exclude: ^$

ci:
autoupdate_schedule: quarterly
skip: [taplo-lint]

repos:
- repo: https://github.com/repo-helper/pyproject-parser
Expand All @@ -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
Expand All @@ -31,15 +31,24 @@ 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:
- --allow-git
- 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
Expand Down Expand Up @@ -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$
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Contributing Guide

.. start short_desc

**Contributing guide for repo-helper and associated projects**
**Contributing guide for projects in the python-coincidence organization.**

.. end short_desc

View online at https://contributing.repo-helper.uk
View online at https://contributing-to-coincidence.readthedocs.io/
2 changes: 1 addition & 1 deletion contributing/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# __init__.py
"""
Contributing guide for repo-helper and associated projects.
Contributing guide for projects in the python-coincidence organization.
"""
#
# Copyright © 2020-2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
Expand Down
1 change: 1 addition & 0 deletions doc-source/_templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
{% extends "!base.html" %}
{% block extrahead %}
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
<link rel=icon href=https://python-coincidence.github.io/assets/coincidence.ico sizes="48x48" type="image/vnd.microsoft.icon">
{% endblock %}
Binary file added doc-source/coincidence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion doc-source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,5 @@ def setup(app):
nitpicky = True
del version
del release
html_title = "repo-helper Contributing Guide"
html_title = "python-coincidence Contributing Guide"
html_logo = "coincidence.png"
2 changes: 1 addition & 1 deletion doc-source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ With bash:

.. code-block:: bash

(repo-helper) $
(coincidence) $


.. _GitHub: https://github.com/
Expand Down
5 changes: 5 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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-coincidence organization."
readme = "README.rst"
keywords = []
dynamic = [ "requires-python", "classifiers", "dependencies",]
Expand All @@ -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-coincidence/contributing"
"Issue Tracker" = "https://github.com/python-coincidence/contributing/issues"
"Source Code" = "https://github.com/python-coincidence/contributing"
Documentation = "https://contributing-to-coincidence.readthedocs.io"

[tool.whey]
base-classifiers = []
Expand All @@ -33,7 +33,7 @@ license-key = "MIT"
[tool.importcheck]

[tool.sphinx-pyproject]
github_username = "repo-helper"
github_username = "python-coincidence"
github_repository = "contributing"
author = "Dominic Davis-Foster"
project = "contributing"
Expand Down
11 changes: 7 additions & 4 deletions repo_helper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ modname: 'contributing'
copyright_years: '2020-2021'
author: 'Dominic Davis-Foster'
email: 'dominic@davis-foster.co.uk'
username: 'repo-helper'
username: 'python-coincidence'
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-coincidence organization.'

use_whey: True
docs_fail_on_warning: true
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-coincidence.readthedocs.io

python_versions:
- '3.8'
Expand All @@ -25,7 +25,8 @@ sphinx_conf_epilogue:
- nitpicky = True
- del version
- del release
- html_title = "repo-helper Contributing Guide"
- html_title = "python-coincidence Contributing Guide"
- html_logo = "coincidence.png"

extra_sphinx_extensions:
- html_section
Expand All @@ -34,3 +35,5 @@ exclude_files:
- contributing
- Source_rst
- license_rst

preserve_custom_theme: true
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading