semantic-release & documentation
#4
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
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 - Enhance README with installation and contribution guidelines This enables fully automated versioning and releases for the MCP server wrapper.
Follows the Cracking Shells' organization guidelines and introduces both user and developer documentation.
It also adds a glossary with common technical terms used extensively in this documentation.
The readme is updated to integrate with the new documentation and help users go where they want.
- Moved the `CONTRIBUTING.md` from the root to the developper's documentation
- With enhanced explanations
- It could be separated into several documents in the future
- Add user's documenation
- API reference is in the user side as `Hatch-MCP-Server` provides a python package, so users are the consumer of this package
- This is a manually written API but future documentation updates will leverage automated API writers
- Add explanations regarding the citation system, usage examples and a "GettingStarted.md"
- Add devs' documentation with an overview and rational for the decisions taken for this little wrapper.
## [0.3.0-dev.1](v0.2.0...v0.3.0-dev.1) (2025-09-06) ### Features * migrate to semantic-release ([b8f8673](b8f8673)) ### Documentation * first pass on documentation ([4a283b3](4a283b3))
This is still a mandatory step until we use `semantic-release` plugins that do that for us as well as publication to `PyPi`
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.
The main changes include setting up semantic-release for automated versioning and changelog generation, enforcing conventional commit messages with commitlint, and providing comprehensive documentation and a glossary for the project.
Automated Release and Commit Workflow
.github/workflows/semantic-release.ymlto enable semantic-release for automated versioning, changelog updates, and GitHub releases on pushes tomainanddevbranches. This workflow includes Python testing and secure token generation for releases..github/workflows/commitlint.ymlto enforce conventional commit message standards on pull requests tomainanddevusing commitlint..releaserc.jsonto configure semantic-release, specifying branch rules, commit analysis, changelog generation, git tagging, and GitHub release settings..commitlintrc.jsonto define commitlint rules, including allowed commit types and subject formatting requirements.Documentation Improvements
README.mdwith detailed project description, installation instructions, usage examples, documentation links, contribution guidelines, and requirements.docs/articles/devs/architecture/Overview.mdto explain the architectural design, wrapper pattern, automatic resource registration, module detection, logging integration, and testing strategies.docs/articles/appendices/glossary.mdproviding definitions of key terms used in the project and documentation.Release and Changelog
CHANGELOG.mdentry for version0.3.0-dev.1, documenting migration to semantic-release and initial documentation improvements.