OpenSystemsDevelopment / qpdf

Commit 6e5f62b05c7628c655ba623f5f5c5d20650826a3

Authored by Jay Berkenbilt
1 parent d67cef64

Tweak release instructions. 

I always think of doing this after I have already tagged the release.
Inline Side-by-side
Showing 1 changed file with 24 additions and 19 deletions
README-maintainer.md
  View file @6e5f62b
... ... @@ -541,9 +541,9 @@ When done, the following should happen:
541 541 `make_dist` verifies this consistency, and CI fails if they are
542 542 inconsistent.
543 543  
544   -* Update release notes in manual. Review version control history.
545   - Update release date in `manual/release-notes.rst`. Change "not yet
546   - released" to an actual date for the release.
  544 +* Review version control history. Update release date in
  545 + `manual/release-notes.rst`. Change "not yet released" to an actual
  546 + date for the release.
547 547  
548 548 * Commit changes with title "Prepare x.y.z release"
549 549  
... ... @@ -574,7 +574,7 @@ When done, the following should happen:
574 574 verify the checksums from the job output, rename to remove -ci from
575 575 the names, and extract to the release archive area.
576 576  
577   -* Sign the source distribution:
  577 +* From the release area, sign the source distribution:
578 578  
579 579 ```
580 580 version=x.y.z
... ... @@ -602,10 +602,10 @@ chmod 555 *.AppImage
602 602 `README-what-to-download.md` separately onto the download area if
603 603 needed.
604 604  
605   -* Ensure that the main branch has been pushed to github. The
606   - rev-parse command below should show the same commit hash for all its
607   - arguments. Create and push a signed tag. This should be run with
608   - HEAD pointing to the tip of main.
  605 +* From the source tree, ensure that the main branch has been pushed to
  606 + github. The rev-parse command below should show the same commit hash
  607 + for all its arguments. Create and push a signed tag. This should be
  608 + run with HEAD pointing to the tip of main.
609 609  
610 610 ```
611 611 git rev-parse qpdf/main @
... ... @@ -638,29 +638,33 @@ url=$(gcurl -s -XPOST https://api.github.com/repos/qpdf/qpdf/releases -d'{"tag_n
638 638 # Get upload url
639 639 upload_url=$(gcurl -s $url | jq -r '.upload_url' | sed -E -e 's/\{.*\}//')
640 640 echo $upload_url
  641 +```
  642 +
  643 +* From the release area, Upload all the files.
641 644  
642   -# Upload all the files. You can add a label attribute too, which
643   -# overrides the name.
  645 +```
644 646 for i in *; do
645 647 mime=$(file -b --mime-type $i)
646 648 gcurl -H "Content-Type: $mime" --data-binary @$i "$upload_url?name=$i"
647 649 done
648 650 ```
649 651  
650   -If needed, go onto github and make any manual updates such as
651   -indicating a pre-release, adding release notes, etc.
  652 +Go onto github, and make any manual updates such as indicating a
  653 +pre-release, adding release notes, etc.
652 654  
653   -Template for release notes.
  655 +Here is a template for the release notes. Change
  656 +`README-what-to-download` to just a file reference for SourceForge
  657 +since there is no relative link target from the news area.
654 658  
655 659 ```
656   -This is qpdf version x.y.z. (Brief description)
  660 +This is qpdf version x.y.z. (Brief description, summary of highlights)
657 661  
658   -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
659   -the available source and binary distributions.
  662 +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.
660 663 ```
661 664  
  665 +* Publish release.
  666 +
662 667 ```
663   -# Publish release
664 668 gcurl -XPOST $url -d'{"draft": false}'
665 669 ```
666 670  
... ... @@ -673,8 +677,9 @@ rsync -vrlcO ./ jay_berkenbilt,qpdf@frs.sourceforge.net:/home/frs/project/q/qp/q
673 677 * On sourceforge, make the source package the default for all but
674 678 Windows, and make the 64-bit msvc build the default for Windows.
675 679  
676   -* Publish a news item manually on sourceforge using the release notes text. Remove the relative link
677   - to README-what-to-download.md (just reference the file by name)
  680 +* Publish a news item manually on sourceforge using the release notes
  681 + text. Remove the relative link to README-what-to-download.md (just
  682 + reference the file by name)
678 683  
679 684 * Upload the debian package and Ubuntu ppa backports.
680 685  
... ...