Skip to content

Commit

Permalink
Update how-to release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
cbm755 committed May 15, 2024
1 parent 988b79e commit 48d1adc
Showing 1 changed file with 17 additions and 24 deletions.
41 changes: 17 additions & 24 deletions HOWTO-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ How to do a release
We use x.y.z. Bump y for minor changes or z for "micro" changes (bug
fixes etc).

OctaveForge process: http://octave.sourceforge.net/developers.html
TODO: read this during next release, and update below.
Old OctaveForge process: http://octave.sourceforge.net/developers.html
which is changing, some comments on this below.


Checklist
Expand Down Expand Up @@ -42,37 +42,28 @@ Checklist

* Ensure sourceforge and github both have up-to-date main branch.

* Create ticket for release on sourceforge. Upload tarball, html
tarball and md5sums.
* tag `git tag -a v3.x.y -m "Version 3.x.y"`

- get checklist https://wiki.octave.org/Reviewing_Octave_Forge_packages
* Make sure tags are current on both sourceforge and github.
`git push --tags origin main`.
`git push --tags sourceforge main`.
(cbm can do this part, TODO and it may not be necessary long term)

- fill it out as best we can

* DEPRECATED Sourceforge ticket
- Create ticket for release on sourceforge. Upload tarball, html
tarball and md5sums.
- get checklist https://wiki.octave.org/Reviewing_Octave_Forge_packages
- fill it out as best we can
- Ticket should include the git hash to be tagged.

* tagging happens after review, by admins!

- If packages seem ok, hopefully someone else will +1 the release but this
is no longer essential (summer 2022)

- then we can tag:

`git tag -a v3.x.y -m "Version 3.x.y"`
* Upload package to SourceForge (TODO: may change in future)

- I use their Web UI to upload the tarball.
- Follow the admin instructions under the review wiki above:

`sftp` is useful for looking, and can then use `rsync`, something like
`rsync -auvn --delete ./tmp/symbolic-html/symbolic/ <user>@web.sourceforge.net:/home/project-web/octave/htdocs/packages/symbolic/`
(only certain users can do this: ask cbm for now)

- TODO: summer 2022: longer term, we might invert this process, tagging on github
before review.

* Make sure tags are current on both sourceforge and github.
`git push --tags origin main`.
`git push --tags sourceforge main`.
(cbm can do this part, TODO and it may not be necessary long term)

* Do github-related release tasks:

Expand All @@ -84,6 +75,8 @@ Checklist

- Do github release (copy-paste from last time, update link).

- upload tarball to GitHub release as well.

* Update the https://gnu-octave.github.io/packages/ yaml file

- see https://github.com/gnu-octave/packages/blob/main/CONTRIBUTING.md
Expand All @@ -94,6 +87,6 @@ Checklist
AFTER release
=============

* Bump version by appending "+" in sympref.m and DESCRIPTION.
* Bump version by appending "+" in sympref.m and DESCRIPTION, and creating a new header in NEWS.

* Optionally, update the make_windows_bundle script. DEPRECATED.

0 comments on commit 48d1adc

Please sign in to comment.