Skip to content

Commit

Permalink
chore: Release preparation kitchen sink
Browse files Browse the repository at this point in the history
- Use justfile instead of Makefile, since the release script can be
  integrated natively: `just release patch`. Might be possible to even
  include this in pyproject.toml since `uv` will provide a task runner
  (astral-sh/uv#5903) that might be based on
  just.

- Adjust the linting checks in the CI to run against the whole project.

- Add commitizen for bumping the release. This was provided by poetry in
  the past. I make too many mistakes without a tool here. In the future,
  this will be covered by uv as well: astral-sh/uv#6298

- next… let's try to release a dev release and let's have a look if the
  pipeline works correctly.
  • Loading branch information
rumpelsepp committed Dec 19, 2024
1 parent 7a9f0f1 commit 6e028b0
Show file tree
Hide file tree
Showing 8 changed files with 120 additions and 231 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
- name: Run ruff
run: |
uv run ruff check src tests
uv run ruff check
- name: Run mypy
run: |
Expand Down
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Several linters and unit tests are used to catch programming errors and regressi
The relevant tools and their versions are specified in the `pyproject.toml`.
[Github Actions](https://docs.github.com/en/actions) are configured to run against all merge requests.

To run these checks locally, use `make lint` and `make test`.

## Commit Messages

We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for structured commit messages.
58 changes: 0 additions & 58 deletions Makefile

This file was deleted.

44 changes: 44 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# SPDX-FileCopyrightText: AISEC Pentesting Team
#
# SPDX-License-Identifier: CC0-1.0

default:
@just --list

lint:
mypy --pretty src tests
ruff check
ruff format --check
find tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shellcheck
reuse lint

lint-win32:
mypy --platform win32 --exclude "gallia\/log\.py" --exclude "hr" src tests
ruff check src tests

fmt:
ruff check --fix-only
f format
d tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shfmt -w

make-docs:
make -C docs html

run-all-tests: run-pytest run-bats

run-pytest:
python -m pytest -v --cov={{justfile_directory()}} --cov-report html tests/pytest

run-bats:
./tests/bats/run_bats.sh

gen-constants:
./scripts/gen_constants.py | ruff format - > src/gallia/transports/_can_constants.py

release increment:
cz bump --increment {{increment}}
git push --follow-tags
gh release create "v$(cz version -p)"

clean:
make -C docs clean
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ dev = [
"ruff >=0.8.0",
"sphinx-rtd-theme >=3",
"types-tabulate >=0.9,<0.10",
"commitizen>=4.1.0",
]

[project.urls]
Expand Down
1 change: 0 additions & 1 deletion scripts/gen_constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

import socket


TEMPLATE = f"""# This file has been autogenerated by `make constants`.
# !! DO NOT CHANGE MANUALLY !!
Expand Down
169 changes: 0 additions & 169 deletions scripts/release.py

This file was deleted.

Loading

0 comments on commit 6e028b0

Please sign in to comment.