Skip to content

Commit 22eaeb1

Browse files
committed
Release 2.0.0a3
1 parent b1c37d5 commit 22eaeb1

File tree

4 files changed

+515
-466
lines changed

4 files changed

+515
-466
lines changed

Makefile

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1919
#TODO: VALEFILES := $(shell find $(DOCS_DIR) -type f -name "*.md" -print)
2020
#TODO: VALEOPTS ?=
2121
PYTHONVERSION = >=3.10,<3.15
22+
VERSION := $(shell uv version --short)
2223

2324
# Add the following 'help' target to your Makefile
2425
# And add help text after each target name starting with '\#\#'
@@ -224,9 +225,14 @@ rtd-prepare: ## Prepare environment on Read the Docs
224225
rtd-pr-preview: rtd-prepare dev ## Build pull request preview on Read the Docs
225226
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/
226227

227-
#TODO .PHONY: release
228-
#release: dev compile ## Release with zest.releaser
229-
# @uv run fullrelease
228+
.PHONY: dist
229+
dist: ## Clean dist, then build the project
230+
@git add .
231+
@git commit -m "Release $(VERSION)"
232+
@git tag $(VERSION)
233+
@git push origin $(VERSION)
234+
@rm -rf dist
235+
@uv build
230236

231237
.PHONY: all
232238
all: clean linkcheck html ## Clean docs build, then run linkcheck, and build html

RELEASE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Release sphinxcontrib-httpdomain
2+
3+
Use uv and make to release sphinxcontrib-httpdomain.
4+
5+
Check the current version.
6+
7+
```shell
8+
uv version
9+
```
10+
11+
Find the correct command to bump the version from [uv's documentation](https://docs.astral.sh/uv/guides/package/#updating-your-version).
12+
Use `--dry-run` to check that the command will do what you expect.
13+
14+
```shell
15+
uv bump --dry-run <args>
16+
```
17+
18+
If it looks good, then drop the `--dry-run` flag, and run the command.
19+
20+
```shell
21+
uv bump <args>
22+
```
23+
24+
Commit the changes, tag the commit, push to the repository, clean the `dist` directory, build the project.
25+
26+
```shell
27+
make dist
28+
```
29+
30+
Publish the project.
31+
32+
```shell
33+
uv publish
34+
```
35+
36+
Create a git tag of the version, and push it.
37+
38+
```shell
39+
git tag <version>
40+
git push origin <version>
41+
```
42+
43+
Navigate to the [releases page](https://github.com/sphinx-contrib/httpdomain/releases) to publish the release.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "sphinxcontrib-httpdomain"
3-
version = "2.0.0a1"
3+
version = "2.0.0a3"
44
description = "Sphinx extension that provides a domain for documenting HTTP APIs."
55
keywords = [
66
"Sphinx",

0 commit comments

Comments
 (0)