Changelog¶
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Unreleased¶
v2.0.0 - 2023-07-11¶
Added¶
- Added step to forward multiple images.
- Use pre-commit to improve developer experience.
-
Implemented parallel execution of actions. This breaks backwards compatibility with
1.X
versions when used as a library. Config files are still compatible with the new execution engine, however some steps are now being executed in parallel:BuildImages
ForwardImages
PullImage
Furthermore the
Group
step was added to allow custom parallel execution. Take a look at the documentation to learn more!
Fixed¶
- Recompiled
requirements.txt
.
v1.1.0 - 2023-02-28¶
Added¶
- Allow specifying additional tags when building or forwarding an image on a per step basis.
Changed¶
extract_from_image
now requires full image names allowing extraction from remote images.- Documentation will now only be published for new releases.
Fixed¶
- Documentation Typos
v1.0.0 - 2023-02-23¶
Added¶
- Added publishing documentation.
- Added missing tests to push coverage to 100%. New code will need to be tested from now on.
- Require at least python 3.10
- Linting for PRs using github actions
- Automatically update documentation via gh actions.
- Extended Documentation
Changed¶
- Configuration for black and flake8.
- Call
Builderer
methods using keyword arguments from file config when ever possible. - Updated dependencies and merged into single
requirements.txt
Removed¶
- Deleted Python 3.9 package classifier.
Fixed¶
dockerfile
argument was not honored when specified in file config.
v0.4.1 - 2023-02-18¶
Added¶
- Option to specify which Dockerfile to use for
build_image
andBuildImage
. - Added usage documentation.
- Publish builderer to PyPI via github actions.
Fixed¶
- Up to date CLI docs
- Load license shields from pipy to reduce github token load
v0.4.0 - 2023-02-13¶
Added¶
- Development requirements pinned using pip compile
- Extended documentation configuration
- added navigation to footer
- added copyright notice to footer
- added social links to footer
- instant page loading
- moved page table of contents (right) into main navigation (left)
- added scroll to top button
- Added editor integration for
.builderer.yml
- Added links for each release showing what changed using github's compare function.
- Improved config validation and error display
- Added docstrings in
builderer.builderer.Builderer
- Added mkdocstrings to generated references.
- Added Documentation for json / yaml schema
- Extended CLI documentation:
- Documented usage as library
Changed¶
- Renamed
BuildConfig
to builderer config for clarity and editor integration. - Reworked shields in documentation and README.md
Fixed¶
- PyPI project urls
- Fixed broken nested lists with two spaces using mdx_truly_sane_lists see this issue
v0.3.0 - 2023-02-10¶
Added¶
- Added example workspace containing a docker compose project with frontend backend and database
- Added tests using pytest
- Added online documentation using MkDocs and Material for MkDocs
- Additional URLs on PyPI to documentation, changelog, code and issue tracker
Changed¶
- Moved from pydanctic argparse to pythons argparse
Removed¶
- Removed
name
from build config
v0.2.0 - 2023-02-08¶
Added¶
- Added command line interface with config files using Pydantic and Pydantic Argparse
- Updated README.md to reflect changes
- pin requirements and their dependencies using pip compile
- Added link to this changelog in README.md
- Initial PyPI release
- Improved package metadata
Changed¶
- The
Builderer
object can now be imported directly from the package.
v0.1.0 - 2023-02-07¶
Added¶
- README
- LICENSE
- .gitignore
- Builderer-Package with PEP 518 Metadata
- Changelog
- Use bump2version