Use semantic-release & add documentation
#16
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
September 9, 2025 08:12
Adopt semantic-release for automated versioning. All future commits must follow Conventional Commits format. - Add semantic-release configuration and workflows - Add commitizen for guided commit messages - Add commitlint for PR validation - Update documentation for new workflow - Update repository URLs to CrackingShells organization This enables fully automated versioning and releases for the validation library.
Original diagrams `chain_of_responsibility_overview.puml`, `three_component_architecture.puml`, `version_agnostic_access.puml` were too complicated. Replacing them in favor several PlantUML diagrams to inform separately about - the objects involved in the chain of responsibility pattern (overview and detailed) - the objects involved in the strategy pattern - the objects involved in the creation of the chain of responsibility - the sequence through the chain of responsibility (overview and detailed) - Add the rendered svg to the documentation
cracking-shells-semantic-release bot
pushed a commit
that referenced
this pull request
Dec 4, 2025
## 0.8.0 (2025-12-04) * Merge pull request #16 from CrackingShells/dev ([c5c57ce](c5c57ce)), closes [#16](#16) * Merge pull request #17 from CrackingShells/feature/v1-2-2-conda-support ([d9f9c3d](d9f9c3d)), closes [#17](#17) * Merge pull request #18 from CrackingShells/dev ([91e9c76](91e9c76)), closes [#18](#18) * chore: add submodule `cracking-shells-playbook` ([3e7df1e](3e7df1e)) * chore: npm-audit-fix ([8752d47](8752d47)) * chore(release): 0.8.0-dev.1 [skip ci] ([a631656](a631656)) * chore(release): 0.8.0-dev.2 ([ca4f5aa](ca4f5aa)) * fix(accessor): correct v1.2.1 entry point return type ([f90d251](f90d251)) * fix(ci): wrong location of npm package in `.releaserc.sjon` ([0a1d5bd](0a1d5bd)) * ci: add automated PyPI publishing ([82b7316](82b7316)) * ci: migrate to semantic-release ([f05f0cc](f05f0cc)) * test(v1.2.2): add comprehensive test coverage for conda support ([6cfddf1](6cfddf1)) * feat(core): add base accessor method for conda channel support ([e69711b](e69711b)) * feat(factory): register v1.2.2 accessor and validator ([bf73160](bf73160)) * feat(schema): implement v1.2.2 package schema with conda support ([4e2be30](4e2be30)) * feat(service): add conda channel retrieval to PackageService ([d129b65](d129b65)) * docs: diagrams ([7d0f98a](7d0f98a)) * docs: first pass on whole package docs ([02b37f3](02b37f3))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Release automation using Conventional Commits (adds automated workflows for commit linting) and semantic-release, and provides extensive documentation.
Release and Commit Automation
.commitlintrc.jsonto enforce Conventional Commit standards for commit messages, including type restrictions and formatting rules..github/workflows/commitlint.ymlGitHub Actions workflow to automatically lint commit messages on pull requests tomainanddevbranches..github/workflows/semantic-release.ymlworkflow to automate testing and semantic releases, including version calculation, changelog generation, and GitHub release creation..releaserc.jsonto configure semantic-release, specifying branch rules, plugins, release rules, and changelog generation.Documentation