ComPWA Repository Maintenance 0.1.1

🖱️ Developer Experience

• Switch to more efficient black pre-commit hook (#209 and #210)

🔨 Maintenance

• Apply new black formatting (#211)

The full changelog as commits can be found here.

ComPWA Repository Maintenance 0.1.0

First release with its own website: compwa.github.io/repo-maintenance.

✨ New features

• feat: enforce same ci-docs.yml workflow (#30)
• feat: use new GitHub Actions in upgrade jobs (#32)
• feat: update CD workflow and push to minor branch (#36)
• feat: split and simplify notebook install cells (#44)
• feat: upgrade to non-beta black release (#46)
• feat: insert autolink-concat directive (#47)
• refactor: rename fix-first-nbcell to set-nb-cells (#49)
• automatically update commitlint.config.js (#80)
• automatically update release drafter (#81)
• add link to diff with previous release (#91)
• verify installation on Python 3.11 (#100)
• enforce new shared workflows (#99)
• enforce Taplo as a TOML formatter (#116)
• automatically add EditorConfig pre-commit hook (#129)
• allow overwriting CD job for version branches (#130)
• remove user_expressions from cell metadata (#132)
• automatically black and cSpell pre-commit hooks (#142)
• automatically update settings in pyproject.toml (#143)
• enforce Ruff as linter and autofixer (#144)
• remove flake8, isort, pydocstyle, and pylint (#145)
• merge dev tool configurations into pyproject.toml (#146)
• update tool.nbqa.addopts settings (#147)
• recommend and configure VSCode mypy extension (#153)
• add option to run pytest single-threaded (#154)
• add hook for making Colab TOC visible (#174)
• mege setup.cfg into pyproject.toml (#184)
• remove empty tables from pyproject.toml (#185)
• add --no-cspell-update flag (#204)

⚠️ Enhancements and optimizations

• distinguish workflow "create" vs "update" message (#110)
• strictly enforce ci.skip section (#135)
• run GitPod check after other checks (#141)
• extend Ruff ignored rules (#149)
• extend nbQA Ruff ignored rules (#150)
• remove GitPod config if --no-gitpod (#189)
• disable word wrap if .prettierrc has been removed (#191)
• sort JSON document case-insensitive (#197)
• remove redundant Taplo config exclusions (#201)
• add --no-ruff argument (#200)
• add option to not update GitHub Actions (#199)
• only update pyright settings if tool.pyright (#203)
• add more excludes to toml-sort hook (#207)

⚠️ API changes

• refactor!: remove devtools module (#33)
• feat: split and simplify notebook install cells (#44)
• refactor: rename fix-first-nbcell to set-nb-cells (#49)
• remove release-drafter updater (#85)
• add link to diff with previous release (#91)

⚠️ Changes that may affect behavior

• remove release-drafter updater (#85)
• ignore comments in setup.cfg style section (#111)
• remove notebook metadata.attachments (#139)
• remove cell.attachments instead of metadata (#140)
• remove flake8, isort, pydocstyle, and pylint (#145)
• remove from IPython.display import display (#148)
• mege setup.cfg into pyproject.toml (#184)

🐛 Bug fixes

• correctly sort dict items in cSpell config (#101)
• remove caches from ref instead of branch (#102)
• set GH_TOKEN for ComPWA/actions@v1 (#104)
• try to match package name with PyPI name (#107)
• inherit secrets for pushing to PyPI (#112)
• create .github/workflow if non-existent (#128)
• allow adding additional jobs to CD workflow (#131)
• extend Ruff ignored rules (#149)
• add permissions id-token to doc job (#156)
• point to absolute mypy config path (#190)
• create .github/workflows directory if non-existent (#198)
• ignore whitespaces in TOML comparison (#202)
• do not lint bib files in subdirs (#205)
• sort nested entries in cSpell config (#206)

📝 Documentation

• convert Zenodo to CITATION.cff config (#166)
• host API documentation for repoma module (#193)
• automatically document check-dev-files arguments (#195)

🔨 Maintenance

• refactor: collect helper functions in top module (#29)
• ci: autoupdate pre-commit hooks (#65)
• ci: autoupdate pre-commit hooks (#75)
• ci: autoupdate pre-commit hooks (#78)
• manage GitHub repository labels from this repo (#82)
• autoupdate pre-commit hooks (#84)
• autoupdate pre-commit hooks (#87)
• autoupdate pre-commit hooks (#89)
• autoupdate pre-commit hooks (#90)
• autoupdate pre-commit hooks (#92)
• outsource cache cleaning to ComPWA/actions (#103)
• autoupdate pre-commit hooks (#109)
• simplify Executor syntax with finalize() (#122)
• use VS Code built-in JSON sorter (#123)
• remove outdated VS Code settings (#126)
• autoupdate pre-commit hooks (#121)
• autoupdate pre-commit hooks (#133)
• autoupdate pre-commit hooks (#137)
• autoupdate pre-commit hooks (#152)
• remove deprecated linter VSCode settings (#159)
• remove pycharm from cell metadata (#172)
• autoupdate pre-commit hooks (#176)
• update workflow OS to Ubuntu 22.04 (#188)
• move labels configuration to labels/ folder (#196)

🖱️ Developer Experience

• ci: upgrade pinned requirements (#24)
• ci: upgrade pinned requirements (#25)
• ci: autoupdate pre-commit hooks (#26)
• ci: autoupdate pre-commit hooks (#28)
• ci: autoupdate pre-commit hooks (#31)
• ci: abort requirements workflow if PR from fork (#35)
• ci: check dependency changes in separate job (#38)
• ci: autoupdate pre-commit hooks (#39)
• ci: autoupdate pre-commit hooks (#42)
• fix: run requirements cron job on even weeks only (#48)
• ci: autoupdate pre-commit hooks (#50)
• ci: autoupdate pre-commit hooks (#53)
• chore(deps): bump actions/setup-python (#72)
• chore(deps): bump pull-request-name-linter-action (#69)
• chore(deps): bump codecov/codecov-action (#70)
• chore(deps): bump actions/upload-artifact (#71)
• ci: autoupdate pre-commit hooks (#79)
• manage GitHub repository labels from this repo (#82)
• update "✨ Feature" issue label (#106)
• specify for which branch to clean caches (#105)
• use VS Code built-in JSON sorter (#123)
• activate pytest type hint support for VS Code (#124)
• recommend ms-vscode.live-server extension (#125)
• recommend VS Code GitHub Actions extension (#127)
• pin CI workflow for GitHub Actions extension (#136)
• avoid setting python.analysis.diagnosticMode (#151)
• recommend and configure VSCode mypy extension (#153)
• specify config file for mypy in VSCode (#155)
• recommend black extension for vscode (#160)
• set Black extension as default formatter (#161)
• autoupdate new pre-commit hooks (#167)
• convert Zenodo to CITATION.cff config (#166)
• switch to black-jupyter pre-commit hook (#171)
• remove markdownlint support (#173)
• remove GitHub issue and PR templates (#178)
• Build(deps): bump actions/checkout from 3 to 4 (#181)
• lint PRs with @compwa/commitlint-config (#186)
• show all symbols in Jupyter notebooks (#187)
• point to absolute mypy config path (#190)
• configure rewrap extension for VSCode (#192)
• automatically document check-dev-files arguments (#195)

The full changelog as commits can be found here.

Repo Maintenance 0.0.23

Release 0.0.23

💡 New features

Enforce pined requirements in each notebook (#23)

Designed particularly for ComPWA/compwa.github.io#10

Repo Maintenance 0.0.22

Release 0.0.22

💡 New features

Enforce auto-close milestone workflow (#22)

Closes #21

🖱️ Developer Experience

Cron job frequency has been reduced to every two months (#20)

Repo Maintenance 0.0.6

Release 0.0.6

💡 New features

Allow turning off label.toml check (#12). Can be done with the --alow-labels argument in the .pre-commit-config.yaml file:

  - repo: https://github.com/ComPWA/repo-maintenance
    rev: 0.0.6
    hooks:
      - id: check-dev-files
        args:
          - --allow-labels

Repo Maintenance 0.0.5

Release 0.0.5

💡 New features

Sort content in entries of cspell config (#10)

The check-dev-files now checks whether the contents of entries in a .cspell.json config file are sorted.

Check missing entries cspell config (#11)

Check whether the .cspell.json config contains all expected entries as defined in the src/repoma/.cspell.json file.

Repo Maintenance Release 0.0.3

Added a new hook: check-dev-files. Once this hook is added to a repo, new checks added to the ComPWA/repo-maintenance repo are automatically enforced.

repos:
  - repo: https://github.com/ComPWA/repo-maintenance
    rev: 0.0.2
    hooks:
      - id: check-dev-files
      - id: fix-first-nbcell
      - id: fix-nbformat-version

Currently only contains a check on whether a [pre-commit hook for EditorConfig]https://github.com/editorconfig-checker/editorconfig-checker.python) has been added, and checks whether labels.toml has been removed.