Skip to content

Commit 73aee15

Browse files
committed
Release v1.1.0
1 parent fb5d5ab commit 73aee15

File tree

3 files changed

+44
-19
lines changed

3 files changed

+44
-19
lines changed

CHANGELOG.md

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

3-
## [v1.1.0](https://github.com/executablebooks/sphinx-exercise/tree/v1.1.0) (TBD)
3+
## [v1.1.0](https://github.com/executablebooks/sphinx-exercise/tree/v1.1.0) (2025-10-22)
44

55
### New ✨
66

@@ -10,9 +10,12 @@
1010

1111
### Improved 👌
1212

13+
- **Updated test suite for Python 3.11-3.13 and Sphinx 6-8 compatibility** ([#79](https://github.com/executablebooks/sphinx-exercise/pull/79))
14+
- **Migrated from os.path to pathlib.Path throughout codebase for modern Python best practices**
1315
- Reorganized and expanded translation files with alphabetical sorting
1416
- Enhanced translation documentation with comprehensive guides
1517
- Updated README and documentation to highlight internationalization features
18+
- Fixed README badges to reference main branch instead of master
1619

1720
### Documentation 📚
1821

@@ -22,6 +25,15 @@
2225
- Created releases documentation structure in `docs/releases/`
2326
- Added Copilot instructions for project maintenance
2427

28+
### Testing Infrastructure 🧪
29+
30+
- Added support for Python 3.11, 3.12, and 3.13
31+
- Added support for Sphinx 6, 7, and 8
32+
- Full test matrix: 9 combinations (3 Python versions × 3 Sphinx versions)
33+
- All 110 tests passing across all supported versions
34+
- Regenerated test fixtures for Sphinx 6 and 7 compatibility
35+
- Normalized image hashes for cross-platform test stability
36+
2537

2638
## [v1.0.1](https://github.com/executablebooks/sphinx-exercise/tree/v1.0.1) (2024-XX-XX)
2739

RELEASE.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,37 +54,50 @@ git push origin main
5454
git push origin v1.1.0
5555
```
5656

57-
### 4. Create GitHub Release
57+
### 4. Automated PyPI Publication
58+
59+
After pushing the tag, the GitHub Actions workflow will automatically:
60+
- Run all tests (pre-commit, pytest, docs)
61+
- Build the distribution packages
62+
- Publish to PyPI using the `PYPI_KEY` secret
63+
64+
You can monitor the progress at:
65+
https://github.com/executablebooks/sphinx-exercise/actions
66+
67+
### 5. Create GitHub Release
68+
69+
Once the workflow completes successfully:
5870

5971
1. Go to https://github.com/executablebooks/sphinx-exercise/releases/new
6072
2. Select tag: `v1.1.0`
6173
3. Release title: `v1.1.0 - Internationalization Support`
6274
4. Description: Copy content from `docs/source/releases/v1.1.0.md`
6375
5. Click "Publish release"
6476

65-
### 5. Publish to PyPI
66-
67-
```bash
68-
# Clean previous builds
69-
rm -rf dist/ build/ *.egg-info
70-
71-
# Build distribution
72-
python -m build
73-
74-
# Upload to PyPI (requires PyPI credentials)
75-
python -m twine upload dist/*
76-
```
77-
7877
### 6. Update Documentation
7978

8079
The documentation should automatically build from the new tag on ReadTheDocs. Verify at:
8180
https://ebp-sphinx-exercise.readthedocs.io/en/latest/
8281

8382
### 7. Post-Release
8483

85-
1. Update `docs/source/releases/index.md` to include v1.1.0
86-
2. Create new "Unreleased" section in CHANGELOG.md for future changes
87-
3. Announce release on relevant channels
84+
1. Verify the package is available on PyPI: https://pypi.org/project/sphinx-exercise/
85+
2. Update `docs/source/releases/index.md` to include v1.1.0
86+
3. Create new "Unreleased" section in CHANGELOG.md for future changes
87+
4. Announce release on relevant channels
88+
89+
## Automated Release Process
90+
91+
This project uses GitHub Actions to automatically publish to PyPI when a version tag is pushed:
92+
93+
1. **Triggering**: The workflow is triggered when a tag matching `v*` is pushed
94+
2. **Testing**: All tests (pre-commit, pytest, documentation) must pass
95+
3. **Building**: The workflow builds the distribution packages using `python -m build`
96+
4. **Publishing**: Packages are automatically published to PyPI using the `PYPI_KEY` secret
97+
98+
**Important**: Ensure the `PYPI_KEY` secret is configured in the repository settings with a valid PyPI API token.
99+
100+
The workflow definition can be found in `.github/workflows/ci.yml` under the `publish` job.
88101

89102
## Version Numbering
90103

sphinx_exercise/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:license: MIT, see LICENSE for details.
88
"""
99

10-
__version__ = "1.0.1"
10+
__version__ = "1.1.0"
1111

1212
from pathlib import Path
1313
from typing import Any, Dict, Set, Union, cast

0 commit comments

Comments
 (0)