Skip to content

Release v1.3.1: Enhanced CI/CD and Documentation#2

Merged
km1790 merged 2 commits intomainfrom
release/1.3.1
Jan 23, 2026
Merged

Release v1.3.1: Enhanced CI/CD and Documentation#2
km1790 merged 2 commits intomainfrom
release/1.3.1

Conversation

@km1790
Copy link
Copy Markdown
Owner

@km1790 km1790 commented Jan 23, 2026

Release v1.3.1

Summary

This release enhances the CI/CD pipeline and improves project documentation.

Added

  • GitHub Pages deployment step in release workflow (auto-converts docs to HTML)
  • CONTRIBUTING.md with comprehensive contribution guidelines

Changed

  • Enhanced release workflow with automated test execution before build
  • Release workflow now automatically merges main into develop after release
  • Updated README.md with Getting Started, Quick Start, and Command Line Options sections
  • Updated project structure in README.md to reflect current layout
  • Updated release summary to show all completed actions

CI/CD Improvements

The release workflow now includes:

  1. ✅ Run tests before build
  2. ✅ Build and publish to PyPI
  3. ✅ Create GitHub Release with tag
  4. ✅ Auto-merge main into develop
  5. ✅ Deploy documentation to GitHub Pages

Documentation

Installation

pip install mk2html==1.3.1          # HTML only
pip install mk2html[pdf]==1.3.1     # With PDF support
uv tool install mk2html             # As global tool

Kmakkad added 2 commits January 23, 2026 17:36
… Pages

- Add test execution step before build in release workflow
- Add automatic merge of main into develop after release
- Add GitHub Pages deployment step (converts docs/*.md to HTML)
- Update README.md with Getting Started, Quick Start, CLI options
- Update project structure in README.md
- Add CONTRIBUTING.md with comprehensive contribution guidelines
- Update CHANGELOG.md with all unreleased changes
@km1790 km1790 merged commit 9a15319 into main Jan 23, 2026
9 checks passed
@km1790 km1790 deleted the release/1.3.1 branch January 23, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant