Release Notes
Versioning
We use SemVer for versioning. For the versions available, see the the project tags.
0.1.0
Welcome to 0.1.0 release, which is now at the master branch in the Gitlab repository at Pyckage Cookiecutter
Features:
Introduces #1: Initial implementation of pyckage cookiecutter.
0.1.1
Features:
Introduces #2:
Requirements rearrangement:
create requirements folder for containing requirements files
move requirements.txt to base.txt in requirements folder, requirements-docs.txt to doc.txt in requirements folder, 3. 3. requirements-tests.txt to dev.txt in requirements folder
add dependency file base.txt in doc.txt and dev.txt
adapt changes to corresponding files, such as Makefile, README.rst, pipeline files, setup.py etc
remove redundant dependencies in dev.txt and pyproject.toml
Update Makefile to have ‘python -m’ as prefix for all pip commands to keep it consistent
update test_bake_project.py with make commands for executing tests for linting and pytest
Bug fix:
fix Wrong README file type in package setup.py
fix muted failed version import in setup.py
fix broken setup.py because of requirements rearrangement
0.2.0
Features:
Introduces #4:
Update documentation for release notes
Add more tags in
pyproject.toml
Introduces #5:
Add sphinx.yml for github pages publishing
Adjust documentation in
README.rst
for how to setup CI/CD pipelines in different platformsAdd Acknowledgements section in
README.rst
Introduces #7:
Add twine check in
test_bake_project.py
and github actions for pull requests or pushes to master/develop branchesAdd twine check step in all pipelines in the cookiecutter template
Update corresponding section in
README.rst
at root and adaptREADME.rst
with additional configuration information for pipelinesAdd missing linting checks in github actions file in cookiecutter template
Add whl file extension for twine upload
0.2.1
Features:
Introduces #8:
Update project structure section with new github actions configuration files in
README.rst
Update project links and author links
Introduces #9:
Fix issue, where the doc requirements is referenced with a wrong file name
Merge github actions file
build.yml
tomain.yml
and renamemain.yml
totest.yml
Add
version.py
insetup.cfg
as bump2version files to simplify the deploymentCorrect wrong documentation header in
index.rst
Fix wrong path issue for windows users while building docs in
make.bat