Skip to content

Commit bccfc63

Browse files
Martin Mahnerclaude
authored andcommitted
Release version 1.0.0
🎉 First stable release with comprehensive test coverage and CI/CD - 57 tests covering all functionality - CI/CD workflows for testing and linting - Enhanced PyPI classifiers - Production/Stable development status 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent eeae848 commit bccfc63

File tree

4 files changed

+73
-4
lines changed

4 files changed

+73
-4
lines changed

CHANGELOG.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Changelog
22

3-
## Unreleased
3+
## Version 1.0.0 (2025-11-13)
4+
5+
🎉 **First stable release!** Microdocs is now production-ready with comprehensive test coverage, CI/CD workflows, and a stable API.
46

57
### Added
68

@@ -18,6 +20,21 @@
1820
- Comprehensive testing documentation in CLAUDE.md
1921
- **README badges** - Added PyPI version, test status, Python version support, and license badges
2022

23+
### Changed
24+
25+
- **Development status** upgraded from Beta to Production/Stable
26+
- **Enhanced PyPI classifiers** with better categorization for documentation and text processing
27+
28+
### Deployment
29+
30+
```bash
31+
# Using uv (recommended)
32+
uvx microdocs@1.0 README.md CHANGELOG.md
33+
34+
# Using pip
35+
pip install --upgrade microdocs
36+
```
37+
2138
## Version 0.3.0 (2025-11-13)
2239

2340
### Added

CLAUDE.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,58 @@ pytest --cov=microdocs
8686
- `.github/workflows/test.yml` - Runs tests on Python 3.11, 3.12, 3.13, 3.14
8787
- `.github/workflows/lint.yml` - Runs ruff check and ruff format --check
8888

89+
### Release Process
90+
91+
When creating a new release, follow these steps **in order**:
92+
93+
1. **Run full test suite** - Verify everything passes before releasing
94+
```bash
95+
pytest && ruff check . && ruff format --check .
96+
```
97+
98+
2. **Update version** in `pyproject.toml`
99+
- Bump version number
100+
- Update development status classifier if needed (Alpha → Beta → Production/Stable)
101+
102+
3. **Update CHANGELOG.md**
103+
- Move "Unreleased" section to new version heading with date
104+
- Add summary of changes (Added, Changed, Fixed, etc.)
105+
- Include deployment instructions with new version number
106+
107+
4. **Commit changes**
108+
```bash
109+
git add pyproject.toml CHANGELOG.md
110+
git commit -m "Release version X.Y.Z"
111+
```
112+
113+
5. **Create git tag**
114+
```bash
115+
git tag -a vX.Y.Z -m "Release vX.Y.Z: brief description"
116+
```
117+
118+
6. **Build the package**
119+
```bash
120+
uv build
121+
```
122+
123+
7. **Publish to PyPI**
124+
```bash
125+
uv publish
126+
```
127+
128+
8. **Push changes and tags**
129+
```bash
130+
git push
131+
git push --tags
132+
```
133+
134+
**Important Notes:**
135+
- Always run tests BEFORE building and publishing
136+
- Never build before creating git commit and tag
137+
- Always create git tag BEFORE building
138+
- Update CHANGELOG with actual release date
139+
- Include deployment instructions in CHANGELOG
140+
89141
## Architecture
90142

91143
### Core Components

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "microdocs"
7-
version = "0.3"
7+
version = "1.0"
88
description = "Transform your Markdown files into a self-contained HTML documentation site."
99
readme = "README.md"
1010
authors = [
1111
{ name = "Martin Mahner", email = "martin@mahner.org" }
1212
]
1313
license = "MIT"
1414
classifiers = [
15-
"Development Status :: 4 - Beta",
15+
"Development Status :: 5 - Production/Stable",
1616
"Environment :: Console",
1717
"Environment :: Web Environment",
1818
"Intended Audience :: Developers",

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)