CHANGELOG.md

0.12.0 (2025-02-09)

🚀 Features (4 changes)

• ✨ Split test and coverage uploads for GitHub templates (merge request)
• ✨ Implement GitHub coverage action (merge request)
• ✨ Set up GitLab coverage uploads (merge request)
• ✨ Add option between code coverage and code analysis (merge request)

📦 Build System & CI/CD (1 change)

• 👷 Refine project coverage job (merge request)

⚙️ Internals (1 change)

• ✏️ Fix reference to coverage service in project tasks (merge request)

:construction_site: Template Internals (1 change)

• 👷 Fix template GitLab CI rules for tests (merge request)

📝 Documentation (4 changes)

• 📝 Include CITATION.cff in READMEs (merge request)
• 📝 Update template README instructions (merge request)
• 📝 Update project README with coverage features (merge request)
• 📝 Add code quality service badges for template README (merge request)

0.11.1 (2025-01-26)

🚀 Features (1 change)

• ✨ Enable test reports for the template (merge request)

📦 Build System & CI/CD (3 changes)

• 👷 Enable GitLab test reports for project (merge request)
• 👷 Replace Coveralls with Codacy (merge request)
• 💚 Adapt CI to enable Galactipy Bot merges (merge request)

:construction_site: Template Internals (1 change)

• 👷 Refine rules for template CI (merge request)

📝 Documentation (3 changes)

• 📝 Update project README with test reports feature (merge request)
• 📝 Add Codacy badges for the project (merge request)
• 📝 Fix Codacy warnings (merge request)

0.11.0 (2025-01-24)

🚀 Features (1 change)

• ✨ Add option for behaviour-driven development (merge request)

📦 Build System & CI/CD (1 change)

• 👷 Update GitHub mirror jobs (merge request)

⚙️ Internals (1 change)

• 🔧 Include BDD flux control in post-gen hooks (merge request)

📝 Documentation (1 change)

• 📝 Update READMEs with BDD functionality (merge request)

0.10.0 (2025-01-23)

🚀 Features (1 change)

• ✨ Configure template plugins for Poetry v2.0 (merge request)

📦 Build System & CI/CD (3 changes)

• 👷 Specify Galactipy Bot variable in project CI (merge request)
• 🔥 Remove static version from template (merge request)
• 💚 Fix Alpine tag for GitHub mirror update job (merge request)

⚙️ Internals (1 change)

• 🔥 Update project tasks to comply with Poetry v2.0 (merge request)

:construction_site: Template Internals (1 change)

• 🔥 Remove Poetry plugins task for template (merge request)

💥 Breaking Changes (2 changes)

• 💥 Update template pyproject to Poetry v2.0 (merge request)
• 🔧 Update template pyproject to Poetry v2.0 (merge request)

📝 Documentation (2 changes)

• 📝 Update READMEs with Poetry plugin functionality (merge request)
• 📝 Update project README roadmap (merge request)

⬆️ Dependencies Updates (1 change)

• ⬆️ Update project and template dependencies (merge request)

0.9.0 (2025-01-23)

🚀 Features (7 changes)

• 🔧 Update template Dockerfile (merge request)
• ✨ Enable multiple tags for GitLab Docker images (merge request)
• ✨ Enable multiple tags for GitHub Docker action (merge request)
• ✨ Add GitLab Docker component (merge request)
• ✨ Add GitHub Docker push workflow (merge request)
• ✨ Add Docker login command for GitLab projects (merge request)
• ✨ Add Docker push command to Invoke tasks (merge request)

🔧 Fixes & Refactoring (3 changes)

• 👷 Fix deficient GitHub Docker action (merge request)
• ✏️ Fix default Python path for Windows on project tasks (merge request)
• ✏️ Fix wrong Jinja statement for Docker login task (merge request)

📦 Build System & CI/CD (10 changes)

• 👷 Fix insufficient rule for CI
• 👷 Refine project CI rules and structure (merge request)
• 👷 Enable manual pipelines for draft Merge Requests (merge request)
• 🔧 Add task for generating coverage (merge request)
• 🏗️ Revamp path resolution for project tasks (merge request)
• 👷 Move CI semver regular expressions to variables (merge request)
• 🚚 Update tests to reference new namespace (merge request)
• 🚚 Update project configuration to new namespace (merge request)
• 🔧 Update Cookiecutter configuration to new project namespace (merge request)
• 👷 Update project CI to use custom Docker images (merge request)

⚙️ Internals (3 changes)

• 🔧 Include GitHub workflow removal for Docker (merge request)
• 🔧 Include project coverage task in sweep command (merge request)
• 🔧 Add exception message for nonexistent Invoke installation (merge request)

:construction_site: Template Internals (9 changes)

• 🙈 Update dockerignore for template (merge request)
• 🔧 Add jinja conditional for GitLab Docker stages (merge request)
• 👷 Set up template GitLab Docker stages (merge request)
• 🙈 Update Dockerignore file for template (merge request)
• 🔒 Ensure password STDIN for Docker login (merge request)
• ✏️ Fix malformed Docker repositories (merge request)
• 🔧 Update Python Docker image to Debian bookworm (merge request)
• 🩹 Fix Docker remove and push commands (merge request)
• 🔧 Fix existing Docker tasks (merge request)

📝 Documentation (8 changes)

• 📝 Include custom badge for GitLab containers (merge request)
• 📝 Refine Docker README instructions (merge request)
• 📝 Update project README with Docker features (merge request)
• 👥 Update pyproject with previous contributors (merge request)
• 📝 Update licence copyright (merge request)
• 🚚 Replace project namespace for README.md (merge request)
• 🚚 Replace commit references for CHANGELOG.md (merge request)
• 🚚 Replace project URL for auxiliary files (merge request)

0.8.1 (2025-01-14)

🚀 Features (1 change)

• ✨ Add citation file to template (merge request)

📦 Build System & CI/CD (2 changes)

• 👷 Ensure GitHub mirroring in full releases only (merge request)
• 👷 Create job to update github-mirror branch (merge request)

0.8.0 (2025-01-11)

🚀 Features (2 changes)

• ✨ Implement stale issues for GitLab (merge request)
• ✨ Implement autoreleases for template (merge request)

📦 Build System & CI/CD (5 changes)

• 💚 Fix incorrect default CI usage (merge request)
• 💚 Fix project CI workflow usage (merge request)
• 👷 Implement triage policies for project (merge request)
• 👷 Change project CI rules (merge request)
• 💚 Fix Changelog commit job (merge request)

⚙️ Internals (1 change)

• 🦺 Update post-gen hooks with triage policies removal (merge request)

:construction_site: Template Internals (2 changes)

• 👷 Fix template CI rule enforcement
• 👷 Refine template CI for GitLab (merge request)

📝 Documentation (4 changes)

• 📝 Refine project roadmap (merge request)
• 🔧 Move instructions for project access token (merge request)
• 📝 Replace TODOs section with project roadmap (merge request)
• 📝 Add citation file for the project (merge request)

0.7.0 (2025-01-09)

🚀 Features (6 changes)

• 👷 Refine GitLab PyPI upload CI (merge request)
• 🚚 Separate test and production publishing for GitHub Actions (merge request)
• ✨ Add PyPI publishing via GitHub Actions (merge request)
• ✨ Add PyPI publishing via GitLab CI (merge request)
• 🚸 Specify Poetry publishing exceptions (merge request)
• ✨ Add PyPI publishing Invoke commands (merge request)

🔧 Fixes & Refactoring (5 changes)

• ✏️ Fix Test PyPI configuration for Invoke (merge request)
• 🩹 Alter workflow files for optimal structure (merge request)
• 🩹 Fix typos in workflow files (merge request)
• ✏️ Fix missing endraw directive for GitHub PyPI test (merge request)
• 👷 Ensure Poetry installation for template CI (merge request)

📦 Build System & CI/CD (5 changes)

• 👷 Refine rules for automatic releases (merge request)
• 👷 Automatic releases for Galactipy (merge request)
• 👷 Add job for CHANGELOG commit for project (merge request)
• 👷 Set up release notes job for project (merge request)
• 👷 Configure CI to skip Work in Progress commits (merge request)

⚙️ Internals (1 change)

• 📌 Pin Poetry to v1.8.5 (merge request)

:construction_site: Template Internals (13 changes)

• 👷 Change rule for when test workflow runs (merge request)
• 👷 Refine rules GitHub workflows (merge request)
• 👷 Ensure PyPI test publishing for full releases (merge request)
• 🚸 Add emoji to GitHub workflows and job steps (merge request)
• 👷 Set up build and artifacts for PyPI uploads (merge request)
• 🚚 Rename GitHub build workflow (merge request)
• 👷 Correct and simplify PyPI triggers for GitHub (merge request)
• 🚸 Add link to GitHub Actions documentation (merge request)
• 👷 Streamline template GitLab CI (merge request)
• 👷 Move SemVer regex to pipeline variables (merge request)
• 👷 Set up build jobs for template (merge request)
• 👷 Reorganize current template CI (merge request)
• 🔧 Fix template pyproject name keyword (merge request)

📝 Documentation (3 changes)

• 📝 Update READMEs with PyPI publishing (merge request)
• 💡 Correct TODOs marked as UPDATEMEs (merge request)
• 📝 Fill CHANGELOG.md with previous releases (merge request)

⬆️ Dependencies Updates (1 change)

• ⬆️ Upgrade lock file dependencies (merge request)

0.6.1 (2024-12-03)

:construction_site: Template Internals (1 change)

• 🔧 Modify ignored SCM files for Todo Tree (merge request)

0.6.0 (2024-11-10)

🚀 Features (1 change)

• ✨ Add VS Code settings (merge request)

📦 Build System & CI/CD (1 change)

• ✅ Add tests for docstring length validation (merge request)

⚙️ Internals (3 changes)

• 🚨 Fix linter warnings for hooks (merge request)
• 🎨 Add docstring line length validations to hooks (merge request)
• 🔧 Update project Git trailers (merge request)

📝 Documentation (2 changes)

• 📝 Update READMEs with VS Code settings (merge request)
• 📝 Update project documentation with new Git trailers (merge request)

:construction_site: Template Internals (3 changes)

• 🔧 Update template pyproject with preconfigured task-tags (merge request)
• 🔧 Add Todo Tree configuration (merge request)
• 🔧 Add further VS Code settings (merge request)

0.5.0 (2024-11-03)

🚀 Features (2 changes)

• 🚸 Add warning for missing Invoke installation (merge request)
• 🚸 Add Rich format to additional instructions (merge request)

🔧 Fixes & Refactoring (2 changes)

• 🩹 Disable emoji rendering for instructions (merge request)
• 🎨 Reorganize Rich output (merge request)

📦 Build System & CI/CD (2 changes)

• ✅ Add tests for possible instruction outcomes (merge request)
• ✅ Fix additional instructions test (merge request)

📝 Documentation (1 change)

• 📝 Add article on mocking to READMEs (merge request)

⬆️ Dependencies Updates (1 change)

• ➕ Add pytest-mock to project dependencies (merge request)

0.4.1 (2024-11-03)

🔧 Fixes & Refactoring (1 change)

• 🔧 Ensure removal of documentation variable (merge request)

📦 Build System & CI/CD (2 changes)

• 🦺 Remove documentation tasks from post-gen hooks (merge request)
• 🔥 Remove references to documentation variable (merge request)

0.4.0 (2024-11-03)

🚀 Features (2 changes)

• 🚚 Rename task for complete linting (merge request)
• ➕ Add Invoke to template dependencies (merge request)

🔧 Fixes & Refactoring (3 changes)

• 🩹 Fix Docker Invoke commands (merge request)
• ✏️ Fix color option variable in template (merge request)
• ♻️ Change instructions to refer to Invoke (merge request)

📦 Build System & CI/CD (11 changes)

• 🔧 Remove documentation variable from Cookiecutter configuration (merge request)
• 🚨 Fix formatter warnings for project (merge request)
• 📝 Replace Makefile references with Invoke in issue templates (merge request)
• 🔧 Include poetry-bumpversion configuration (merge request)
• 🔧 Optimise tasks with pyproject configuration (merge request)
• 🔧 Update template CI files with Invoke (merge request)
• 🔧 Add multiple Docker images option (merge request)
• 🔧 Remove makefile keyword from configuration (merge request)
• 🔥 Remove template Makefile (merge request)
• 🔧 Create Docker Invoke commands for template (merge request)
• 🔧 Mirror project mypy configuration in template (merge request)

📝 Documentation (1 change)

• 📝 Update READMEs with Invoke references (merge request)

0.3.2 (2024-11-02)

🔧 Fixes & Refactoring (4 changes)

• 🐛 Fix Python path for tasks (merge request)
• 🚨 Fix mypy errors (merge request)
• 🩹 Change active venv path resolution (merge request)
• 🔧 Fix mypy execution error (merge request)

📦 Build System & CI/CD (17 changes)

• 🔥 Remove project Makefile (merge request)
• 🔧 Add flag to ignore PTY in Poetry install (merge request)
• 🔧 Change pip placement in the pipeline (merge request)
• 🔧 Update mypy configuration for the project (merge request)
• 🔧 Improve compilation task syntax (merge request)
• ✅ Fix Coverage exception with pytest-cookies (merge request)
• 🔧 Add poetry-plugin-export explicitly to tasks (merge request)
• 💚 Adhere to PEP 585 for annotating collections (merge request)
• 🔧 Add build directory removal command (merge request)
• 🔧 Create cleaning Invoke commands (merge request)
• 🔧 Add dev dependencies upgrade command (merge request)
• 🔧 Create linting Invoke commands (merge request)
• 🗑️ Remove Poetry installation check for Invoke tasks (merge request)
• 🔧 Rework Invoke paths and environment variables (merge request)
• 🔧 Create project installation Invoke commands (merge request)
• 🔧 Restructure Invoke PATH constants (merge request)
• 🔧 Create Poetry installation Invoke commands (merge request)

📝 Documentation (1 change)

• ✏️ Fix cleaning tasks docstrings (merge request)

⬆️ Dependencies Updates (5 changes)

• ⬆️ Upgrade minimum development version to Python 3.10 (merge request)
• ⬇️ Downgrade Safety to avoid CI failure (merge request)
• ⬆️ Upgrade dev dependencies to latest versions (merge request)
• ⬆️ Deprecate Python 3.8 and add Python 3.13 (merge request)
• ➕ Add Invoke to project dependencies (merge request)

0.3.1 (2024-07-13)

🔧 Fixes & Refactoring (2 changes)

• 🐛 Fix partial module initialisation (merge request)
• 🔧 Update Cookiecutter configuration behaviour (merge request)

0.3.0 (2024-07-13)

🔧 Fixes & Refactoring (18 changes)

• 🚨 Select flake8-boolean-trap rules for template (merge request)
• 🚨 Select flake8-todos rules for template (merge request)
• 🚨 Select additional rules for template (merge request)
• 🚨 Fix missing character in noqa inline comments (merge request)
• 🚨 Fix minor linter warnings for template (merge request)
• 🚨 Select flake8-pytest-style rules for project (merge request)
• 🚨 Select flake8-unused-arguments rules for project (merge request)
• 🚨 Select Pylint rules for project (merge request)
• 🚨 Select flake8-raise rules for project (merge request)
• 🚨 Select flake8-bugbear rules for project (merge request)
• 🚨 Select additional rules for project (merge request)
• 🚨 Select flake8-bandit rules for project (merge request)
• 🚨 Select pep8-annotations for project (merge request)
• 🚨 Select pydocstyle rules for project (merge request)
• 🚨 Select pep8-naming rules for project (merge request)
• 🚨 Select isort rules for project (merge request)
• 🚨 Select pycodestyle rules for project (merge request)
• 🚨 Select Pyflakes rules for project (merge request)

📦 Build System & CI/CD (4 changes)

• 💚 Ignore jinja2 Safety warning (merge request)
• 💚 Replace check-codestyle with check-linter (merge request)
• 🔧 Update project and template Makefiles (merge request)
• 🔧 Include additional ruff configuration (merge request)

📝 Documentation (4 changes)

• 📝 Update non-OSS sections in README (merge request)
• 📝 Update minor issues in project README (merge request)
• 📝 Update Makefile section in READMEs (merge request)
• 📝 Update READMEs with references to Ruff (merge request)

⬆️ Dependencies Updates (4 changes)

• ➕ Update dependencies (merge request)
• 🔧 Implement ruff for template (merge request)
• ➖ Remove old linters and hooks (merge request)
• ➕ Add ruff to project dependencies (merge request)

0.2.3 (2024-05-05)

🔧 Fixes & Refactoring (2 changes)

• 🩹 Correct Poetry licence for non-OSS option (merge request)
• 🐛 Fix behaviour for file removals (merge request)

⬆️ Dependencies Updates (1 change)

• ⬆️ Add support for Python 3.12 (merge request)

0.2.2 (2024-05-05)

🔧 Fixes & Refactoring (4 changes)

• 🚑 Fix PackageNotFoundError import (merge request)
• 🔧 Remove default_language_version from pre-commit (merge request)
• 🔧 Update Cookiecutter configuration (merge request)
• 🎨 Provide hello function at top-level module (merge request)

📦 Build System & CI/CD (1 change)

• 💚 Ensure pip update to latest version (merge request)

⬆️ Dependencies updates (1 change)

• ⬆️ Update Black for safety check (merge request)

0.2.1 (2023-11-19)

🔧 Fixes & Refactoring (1 change)

• 🚑 Fix version retrieval code (merge request)

📦 Build System & CI/CD (2 changes)

• ✅ Modify benchmark test for template (merge request)
• 💚 Mark template test for skip (merge request)

0.2.0 (2023-11-19)

🔧 Fixes & Refactoring (6 changes)

• 🐛 Fix example color output (merge request)
• 🩹 Update importlib_metadata code (merge request)
• 🚑 Fix Poetry reference for package install (merge request)
• 🔧 Replicate coverage config to template files (merge request)
• 🔧 Update TOML with coverage rules (merge request)
• 🩹 Convert tests directory to package (merge request)

📦 Build System & CI/CD (19 changes)

• 👷 Change CI workflow rules (merge request)
• ✅ Add test for template generation (merge request)
• ✅ Add further tests to increase coverage (merge request)
• 👷 Generate coverage report artifact for GitLab (merge request)
• 👷 Enable Coveralls upload for project (merge request)
• ✅ Add tests for unused files removal (merge request)
• ✅ Add non-OSS licence test (merge request)
• 🚚 Organise fixture for licence generation (merge request)
• ✅ Add tests for template generation (merge request)
• ✅ Add tests for licence generation (merge request)
• 🧪 Include tests for protected file/directory (merge request)
• ✅ Create class tests for additional operations (merge request)
• ✅ Add class test for file/directory operations (merge request)
• ✅ Add semver unit tests (merge request)
• ✅ Add username unit tests (merge request)
• ✅ Add package name unit tests (merge request)
• ✏️ Include raw string reference for reserved names (merge request)
• ✅ Add repo name unit tests (merge request)
• 🔥 Adjust project slug regex (merge request)

📝 Documentation (2 changes)

• 📝 Update READMEs with information on testing (merge request)
• 📝 Update CONTRIBUTING with GitHub mirror

⬆️ Dependencies Updates (8 changes)

• ➕ Add pytest-benchmark to template dependencies (merge request)
• ➕ Add pytest-click to template dependencies (merge request)
• ➕ Add pytest-pikachu to template dependencies (merge request)
• ➕ Add pytest-sugar to project and template (merge request)
• ➖ Remove pytest-html from project dependencies (merge request)
• ➕ Add pytest-timeout to project and template (merge request)
• ➕ Add pytest-mock to template dependencies (merge request)
• ➖ Remove coverage-badge from dependencies (merge request)

0.1.0 (2023-10-04)

Initial functional release of galactipy.

🚀 Features

• Option to select between GitLab and GitHub as platforms
• Seven different licences to choose from, plus an option to generate the project as closed source
• Options to use formatters and linters, with further configuration of line length and docstring style
• Options to create Docker image and documentation structure

📦 Build System & CI/CD

• Extended pre-gen hooks to validate repository name and username
• Modified post-gen hooks to remove unnecessary files considering current Cookiecutter options
• GitLab CI configuration mirroring GitHub build to check for codestyle, testing and safety
• Use of poetry-plugin-up for updating dev dependencies via Makefile function

📝 Documentation

• Update to Contributor Covenant v2.1
• Extended README guide with details on how to further set up the project
• Included additional reading suggestions to README

⬆️ Dependencies Updates

• Support from Python 3.8 onwards
• Default dev dependencies set at earliest versions compatible with Python 3.8 through 3.11 (except for flake8)