Skip to content

Commit

Permalink
docs(readme): docs to automatic process of "Release notes"
Browse files Browse the repository at this point in the history
- update structure README, badges, credits
- section about solving conflicts commitizen
- add example screenshots for release notes and changelog
  • Loading branch information
tomassebestik committed Sep 24, 2024
1 parent 19e8cec commit 6a18980
Show file tree
Hide file tree
Showing 12 changed files with 280 additions and 204 deletions.
84 changes: 0 additions & 84 deletions .github/workflows/draft-release.yml

This file was deleted.

6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,9 @@
__pycache__/
_version.py
TODO.md

# Local test to create Release notes
Release_notes.md

# Local test to create full CHANGELOG
CHANGELOG-output.md
84 changes: 18 additions & 66 deletions Justfile
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
set quiet := true
set shell := ["bash", "-c"]
set positional-arguments := true

# Private default task
[private]
default:
just --choose --unsorted

# Gracefully exit just chooser
exit:
exit 0

Expand All @@ -16,74 +13,29 @@ build-install:
python -m build
pip install .
cz example
pip list | grep czespressif
pip list | grep -E 'cz|commitizen'

install:
pip uninstall -y czespressif
pip install -e .
cz example
pip list | grep czespressif

venv39:
/usr/bin/python3.9 -m venv venv
. venv/bin/activate

venv310:
/usr/bin/python3.10 -m venv venv
. venv/bin/activate
dry-bump:
clear
cz bump --dry-run

venv311:
/usr/bin/python3.11 -m venv venv
. venv/bin/activate
example:
clear
cz example

venv312:
/usr/bin/python3.12 -m venv venv
. venv/bin/activate
changelog:
clear
cz changelog --file-name="CHANGELOG-output.md"

# Remove virtual environment
remove-venv:
rm -rf venv
rm -rf .venv
release-notes:
clear
cz changelog v1.0.0 --template="RELEASE_NOTES.md.j2" --file-name="Release_notes.md"

# Reinstall development dependencies in virtual environment
reinstall-venv:
just activate-venv && pip install -e '.[dev]'
live-install:
pip uninstall -y czespressif
pip install -e . '[.dev]'
cz example
pip list | grep -E 'cz|commitizen'

# Clean temporary and cache files
clean-temps:
rm -rf .pytest_cache .mypy_cache .nox .ruff_cache .tox build dist

# Set up the environment: activate and reinstall
setup-env:
just activate-venv && just reinstall-venv

# List outdated Python packages
pip-list-outdated:
just activate-venv && pip list --outdated

# List Python packages excluding editable
pip-list-exlude-editable:
just activate-venv && pip list --exclude-editable

pip-list-search-installed PACKAGE:
just activate-venv && pip list --format=columns | grep '{{PACKAGE}}'

# Run pre-commit checks
pre-commit-all-files:
just activate-venv && pre-commit run --all-files

# Run pre-commit checks on staged files
pre-commit-staged:
just activate-venv && pre-commit run

# Run pre-commit checks and specify files
pre-commit-files FILES:
just activate-venv && pre-commit run --files {{FILES}}

# Autoupdate pre-commit hooks
pre-commit-autoupdate:
just activate-venv && pre-commit autoupdate

# Reuse the last commit message, opening it in the editor for modification
git-fix-message:
git commit --edit --file=$(git rev-parse --git-dir)/COMMIT_EDITMSG
Loading

0 comments on commit 6a18980

Please sign in to comment.