Commit d25eb2961087641330fe896effced4170ba13725
1 parent
04a602aa
Update maintainer notes for doc changes
Showing
2 changed files
with
27 additions
and
12 deletions
README-maintainer
| @@ -305,6 +305,15 @@ git rev-parse qpdf/main @ | @@ -305,6 +305,15 @@ git rev-parse qpdf/main @ | ||
| 305 | git tag -s release-qpdf-$version @ -m"qpdf $version" | 305 | git tag -s release-qpdf-$version @ -m"qpdf $version" |
| 306 | git push qpdf release-qpdf-$version | 306 | git push qpdf release-qpdf-$version |
| 307 | 307 | ||
| 308 | +* Update documentation branches | ||
| 309 | + | ||
| 310 | +git push qpdf @:$(echo $version | sed -E 's/\.[^\.]+$//') | ||
| 311 | +git push qpdf @:stable | ||
| 312 | + | ||
| 313 | +* If this is an x.y.0 release, visit | ||
| 314 | + https://readthedocs.org/projects/qpdf/versions/ (log in with | ||
| 315 | + github), and activate the latest major/minor version | ||
| 316 | + | ||
| 308 | * Create a github release after pushing the tag. `gcurl` is an alias | 317 | * Create a github release after pushing the tag. `gcurl` is an alias |
| 309 | that includes the auth token. | 318 | that includes the auth token. |
| 310 | 319 | ||
| @@ -332,7 +341,7 @@ Template for release notes: | @@ -332,7 +341,7 @@ Template for release notes: | ||
| 332 | ``` | 341 | ``` |
| 333 | This is qpdf version x.y.z. (Brief description) | 342 | This is qpdf version x.y.z. (Brief description) |
| 334 | 343 | ||
| 335 | -For a full list of changes from previous releases, please see the [release notes](https://qpdf.sourceforge.io/doc/html/release-notes.html). See also [README-what-to-download](./README-what-to-download.md) for details about the available source and binary distributions. | 344 | +For a full list of changes from previous releases, please see the [release notes](https://qpdf.readthedocs.io/en/stable/release-notes.html). See also [README-what-to-download](./README-what-to-download.md) for details about the available source and binary distributions. |
| 336 | ``` | 345 | ``` |
| 337 | 346 | ||
| 338 | # Publish release | 347 | # Publish release |
| @@ -347,14 +356,6 @@ rsync -vrlcO ./ jay_berkenbilt,qpdf@frs.sourceforge.net:/home/frs/project/q/qp/q | @@ -347,14 +356,6 @@ rsync -vrlcO ./ jay_berkenbilt,qpdf@frs.sourceforge.net:/home/frs/project/q/qp/q | ||
| 347 | 356 | ||
| 348 | * Publish a news item manually on sourceforge. | 357 | * Publish a news item manually on sourceforge. |
| 349 | 358 | ||
| 350 | -* Update the web page to indicate the new version and to put the new | ||
| 351 | - documentation in the `files` subdirectory of the website on | ||
| 352 | - sourceforge.net. | ||
| 353 | - | ||
| 354 | -(cd /tmp; mkdir -p z; cd z; \ | ||
| 355 | - tar xf ~/Q/storage/releases/qpdf/qpdf/$version/qpdf-$version.tar.gz qpdf-$version/doc; \ | ||
| 356 | - rsync -avx --delete --force --exclude '*.1' qpdf-$version/doc/ jay_berkenbilt,qpdf@frs.sourceforge.net:htdocs/doc/) | ||
| 357 | - | ||
| 358 | * Upload the debian package and Ubuntu ppa backports. | 359 | * Upload the debian package and Ubuntu ppa backports. |
| 359 | 360 | ||
| 360 | * Email the qpdf-announce list. | 361 | * Email the qpdf-announce list. |
| @@ -419,9 +420,22 @@ DOCS ON readthedocs.org | @@ -419,9 +420,22 @@ DOCS ON readthedocs.org | ||
| 419 | * Docs: https://qpdf.readthedocs.io/ | 420 | * Docs: https://qpdf.readthedocs.io/ |
| 420 | * Admin -> Settings | 421 | * Admin -> Settings |
| 421 | * Set project home page | 422 | * Set project home page |
| 422 | - * Advanced: Show version warning | 423 | + * Advanced |
| 424 | + * Show version warning | ||
| 425 | + * Default version: stable | ||
| 423 | * Email Notifications: set email address for build failures | 426 | * Email Notifications: set email address for build failures |
| 424 | 427 | ||
| 425 | At this time, there is nothing in .github/workflows to support this. | 428 | At this time, there is nothing in .github/workflows to support this. |
| 426 | It's all set up as an integration directly between github and | 429 | It's all set up as an integration directly between github and |
| 427 | readthedocs. | 430 | readthedocs. |
| 431 | + | ||
| 432 | +The way readthedocs.org does stable and versions doesn't exactly work | ||
| 433 | +for qpdf. My tagging convention is different from what they expect, | ||
| 434 | +and I don't need versions for every point release. I have the | ||
| 435 | +following branching strategy to support docs: | ||
| 436 | + | ||
| 437 | +* x.y -- points to the latest x.y.z release | ||
| 438 | +* stable -- points to the latest release | ||
| 439 | + | ||
| 440 | +The release process includes updating the approach branches and | ||
| 441 | +activating versions. |
TODO
| 1 | Next | 1 | Next |
| 2 | ==== | 2 | ==== |
| 3 | 3 | ||
| 4 | -* At the time of the release, update the webpage to point to | ||
| 5 | - readthedocs if that's what we decide to do. | 4 | +* At the time of the release, update the webpage and make sure it's |
| 5 | + stable. Check the old release notes link: | ||
| 6 | + http://qpdf.sourceforge.net/files/qpdf-manual.html#ref.release-notes | ||
| 6 | 7 | ||
| 7 | * High-level API/doc overhaul: #593 | 8 | * High-level API/doc overhaul: #593 |
| 8 | 9 |