Releases: lincc-frameworks/python-project-template
v1.2.1
What's Changed
- Specify correct version of add-to-project action. by @drewoldag in #61
- Add cron smoke test by @delucchi-cmu in #63
- Allow hyphens in project name by @delucchi-cmu in #65
New Contributors
- @delucchi-cmu made their first contribution in #63
Full Changelog: 1.2.0...v1.2.1
1.2.0
What's Changed
- modified action to invoke pytest through python by @cchris28 in #48
- Make template tests run the same way hydrated template CI tests run by @drewoldag in #50
- Incorporating setuptools_scm to support programmatic version information by @drewoldag in #56
- Separated linting from the rest of the CI workflow. by @drewoldag in #57
- Add options for linting: pylint, black, none. Make isort optional. by @drewoldag in #58
- Put new issues in lincc-frameworks project by @drewoldag in #59
New Contributors
Full Changelog: v1.1.0...1.2.0
Fixed support for Readthedocs and Codecov
This release fixes a few issues CI and third party integration issues (Codecov reporting, Readthedocs builds), and makes the initial use of a hydrated template much smoother by focusing the pre-commit hooks on just the ./src directory.
What's Changed
- Fix pre-commit issues and make Readthedocs builds work by @drewoldag in #44
- Fix CI issues by @drewoldag in #46
Full Changelog: v1.0.0...v1.1.0
The fundamentals are in place
This release incorporates all the primary functionality including automated testing for the template itself, updated README instructions, automatic document generation, unit testing, code linting, code coverage reporting and pre-commit hooks.
Sphinx autodoc generation, template testing
What's Changed
- Correct order of
git init/pre-commit install
instructions. by @drewoldag in #24 - Moved template into subdirectory, added Copier "_tasks" to initialize git repo by @drewoldag in #26
- Basic generation of documents. by @drewoldag in #29
- Added pre-commit to build documentation with Sphinx. by @drewoldag in #31
- Added GitHub workflow to automatically push to PyPI when a new release is created. by @drewoldag in #33
- Added pylint linting to GitHub workflow. Also pinned the sphinx version. by @drewoldag in #32
- Issue/17/basic automated template testing by @drewoldag in #38
Full Changelog: v0.0.5...v0.0.6
Introduced pylint and isort pre-commit hooks
General code clean up, added docstrings, overhauled the README.
Added 3 new pre-commit hooks:
- pylint
- isort
- validate-pyproject.toml
Basic pytest and code coverage
This release includes a slightly flatter directory structure in addition to two new pre-commit hooks that will run unit tests and prevent merging to the main branch.
Introduces CI stub
This release introduces a stub file to start CI run when a commit is pushed.
Updated pyproject.toml
This release introduces a more realistic pyproject.toml template.
First release
The most rudimentary template.