Skip to content

Commit

Permalink
Merge branch 'release-v3.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
fedejaure committed Nov 16, 2024
2 parents e3840af + 297e4f2 commit d4e1d7b
Show file tree
Hide file tree
Showing 26 changed files with 1,010 additions and 762 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[bumpversion]
commit = True
tag = False
current_version = 3.0.1
current_version = 3.1.0

[bumpversion:file:pyproject.toml]
search = version = "{current_version}"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v4.1.1
uses: actions/checkout@v4.2.2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/pre-commit-autoupdate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ jobs:
name: autoupdate
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- uses: actions/checkout@v4.2.2
with:
ref: develop

- name: Set up Python 3.9
uses: actions/setup-python@v5.0.0
uses: actions/setup-python@v5.3.0
with:
python-version: 3.9

Expand All @@ -28,11 +28,12 @@ jobs:
- name: Run autoupdate
run: poetry run pre-commit autoupdate
continue-on-error: true

- name: Run pre-commit
run: poetry run pre-commit run --all-files

- uses: peter-evans/create-pull-request@v6.0.0
- uses: peter-evans/create-pull-request@v7.0.5
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: chore-update-pre-commit-hooks
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@ on:
tags:
- 'v*'

permissions:
id-token: write
contents: write

jobs:
github_release:
name: Create Github Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- uses: actions/checkout@v4.2.2

- name: Get version from tag
id: tag_name
Expand All @@ -20,7 +24,7 @@ jobs:
- name: Get Changelog Entry
id: changelog_reader
uses: mindsers/[email protected].2
uses: mindsers/[email protected].3
with:
version: ${{ steps.tag_name.outputs.current_version }}
path: ./CHANGELOG.md
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ jobs:
name: Linting
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- uses: actions/checkout@v4.2.2

- name: Set up Python 3.9
uses: actions/setup-python@v5.0.0
uses: actions/setup-python@v5.3.0
with:
python-version: 3.9

Expand All @@ -42,10 +42,10 @@ jobs:
python-version: ['3.9', '3.10', '3.11', '3.12']
fail-fast: true
steps:
- uses: actions/checkout@v4.1.1
- uses: actions/checkout@v4.2.2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5.0.0
uses: actions/setup-python@v5.3.0
with:
python-version: ${{ matrix.python-version }}

Expand Down
8 changes: 4 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default_install_hook_types:
- post-merge
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
rev: v5.0.0
hooks:
- id: check-toml
exclude: "^{{cookiecutter.project_name}}/"
Expand Down Expand Up @@ -33,12 +33,12 @@ repos:
- id: isort
exclude: "^{{cookiecutter.project_name}}/"
- repo: https://github.com/psf/black
rev: 24.2.0
rev: 24.10.0
hooks:
- id: black
exclude: "^{{cookiecutter.project_name}}/"
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.2.1
rev: v0.7.4
hooks:
- id: ruff
args: [ --fix ]
Expand All @@ -48,7 +48,7 @@ repos:
hooks:
- id: validate-cff
- repo: https://github.com/python-poetry/poetry
rev: 1.7.1
rev: 1.8.3
hooks:
- id: poetry-check
- id: poetry-install
12 changes: 12 additions & 0 deletions .safety-policy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: '2.0'

# Safety Security and License Configuration file
security: # configuration for the `safety check` command
ignore-cvss-severity-below: 0 # A severity number between 0 and 10. Some helpful reference points: 9=ignore all vulnerabilities except CRITICAL severity. 7=ignore all vulnerabilities except CRITICAL
ignore-cvss-unknown-severity: False # True or False. We recommend you set this to False.
ignore-vulnerabilities: # Here you can list multiple specific vulnerabilities you want to ignore (optionally for a time period)
# We recommend making use of the optional `reason` and `expires` keys for each vulnerability that you ignore.
70612:
reason: we do not use the vulnerable function
expires: '2025-10-10'
continue-on-vulnerability-error: False # Suppress non-zero exit codes when vulnerabilities are found. Enable this in pipelines and CI/CD processes if you want to pass builds that have vulnerabilities
38 changes: 37 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [3.1.0] - 2024-11-16

### Added
- `.safety-policy.yml` file.

### Changed
- typer from `^0.9.0` to `^0.13.0`.
- coverage from `^7.4.1` to `^7.6.7`.
- pytest-cov from `^4.1.0` to `^6.0.0`.
- sphinx from `^7.2.6` to `^7.4.7`.
- black from `^24.2.0` to `^24.10.0`.
- mypy from `^1.8.0` to `^1.13.0`.
- ruff from `^0.2.1` to `^0.7.4`.
- safety from `^3.0.1` to `^3.2.11`.
- pytest from `^8.0.1` to `^8.3.3`.
- pre-commit from `^3.6.1` to `^4.0.1`.
- xdoctest from `^1.1.3` to `^1.2.0`.
- watchdog from `^4.0.0` to `^6.0.0`.
- poetry pre-commit hooks from `1.7.1` to `1.8.3`.
- pre-commit-hooks from `v4.5.0` to `v5.0.0`.
- codecov/codecov-action from `v3.1.4` to `v4.4.1`.
- actions/upload-artifact from `v4` to `v4.4.3`.
- actions/download-artifact from `v4` to `v4.1.8`.
- actions/setup-python from `v5.0.0` to `v5.3.0`.
- mindsers/changelog-reader-action from `v2.2.2` to `v2.2.3`.
- peter-evans/create-pull-request from `v6.0.0` to `v7.0.5`.
- actions/checkout from `v4.1.1` to `v4.2.2`.

### Fixed
- Citation abstract to be generated with `project_short_description`.
- Docs `conf.py` to the linting target path.
- Release workflow permissions.
- Release Pypi.
- Nox coverage session under an interactive execution.

## [3.0.1] - 2024-02-18
### Fixed
- Github funding file syntax.
Expand Down Expand Up @@ -401,7 +436,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- First release.


[Unreleased]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v3.0.1...develop
[Unreleased]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v3.1.0...develop
[3.1.0]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v3.0.1...v3.1.0
[3.0.1]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v3.0.0...v3.0.1
[3.0.0]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v2.3.1...v3.0.0
[2.3.1]: https://github.com/fedejaure/cookiecutter-modern-pypackage/compare/v2.3.0...v2.3.1
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ authors:
identifiers:
- type: url
value: >-
https://github.com/fedejaure/cookiecutter-modern-pypackage/releases/tag/v3.0.1
description: The Software Heritage link for version 3.0.1.
https://github.com/fedejaure/cookiecutter-modern-pypackage/releases/tag/v3.1.0
description: The Software Heritage link for version 3.1.0.
repository-code: 'https://github.com/fedejaure/cookiecutter-modern-pypackage'
abstract: Cookiecutter template for a modern Python package.
keywords:
- cookiecutter
- template
- package
license: MIT
version: 3.0.1
version: 3.1.0
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ pip install -U cookiecutter
Run Cookiecutter using the latest release

```sh
cookiecutter gh:fedejaure/cookiecutter-modern-pypackage --checkout v3.0.1
cookiecutter gh:fedejaure/cookiecutter-modern-pypackage --checkout v3.1.0
```

### 3. Set up Your Project
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
# built documents.
#
# The short X.Y version.
version = "3.0.1"
version = "3.1.0"
# The full version, including alpha/beta/rc tags.
release = "3.0.1"
release = "3.1.0"

# -- General configuration ---------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx==7.2.6
sphinx==7.4.7
recommonmark==0.7.1
2 changes: 1 addition & 1 deletion docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use cookiecutter, pointing it at the cookiecutter-pypackage repo:

.. code-block:: bash
$ cookiecutter gh:fedejaure/cookiecutter-modern-pypackage --checkout v3.0.1
$ cookiecutter gh:fedejaure/cookiecutter-modern-pypackage --checkout v3.1.0
You'll be asked to enter a bunch of values to set the package up.
If you don't know what to enter, stick with the defaults.
Expand Down
Loading

0 comments on commit d4e1d7b

Please sign in to comment.