Skip to content

Commit 48d1adc

Browse files
committed
Update how-to release notes
1 parent 988b79e commit 48d1adc

File tree

1 file changed

+17
-24
lines changed

1 file changed

+17
-24
lines changed

HOWTO-release.md

+17-24
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ How to do a release
44
We use x.y.z. Bump y for minor changes or z for "micro" changes (bug
55
fixes etc).
66

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

1010

1111
Checklist
@@ -42,37 +42,28 @@ Checklist
4242

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

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

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

50-
- fill it out as best we can
5152

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

54-
* tagging happens after review, by admins!
55-
56-
- If packages seem ok, hopefully someone else will +1 the release but this
57-
is no longer essential (summer 2022)
58-
59-
- then we can tag:
60-
61-
`git tag -a v3.x.y -m "Version 3.x.y"`
60+
* Upload package to SourceForge (TODO: may change in future)
6261

62+
- I use their Web UI to upload the tarball.
6363
- Follow the admin instructions under the review wiki above:
64-
6564
`sftp` is useful for looking, and can then use `rsync`, something like
6665
`rsync -auvn --delete ./tmp/symbolic-html/symbolic/ <user>@web.sourceforge.net:/home/project-web/octave/htdocs/packages/symbolic/`
6766
(only certain users can do this: ask cbm for now)
68-
69-
- TODO: summer 2022: longer term, we might invert this process, tagging on github
70-
before review.
71-
72-
* Make sure tags are current on both sourceforge and github.
73-
`git push --tags origin main`.
74-
`git push --tags sourceforge main`.
75-
(cbm can do this part, TODO and it may not be necessary long term)
7667

7768
* Do github-related release tasks:
7869

@@ -84,6 +75,8 @@ Checklist
8475

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

78+
- upload tarball to GitHub release as well.
79+
8780
* Update the https://gnu-octave.github.io/packages/ yaml file
8881

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

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

9992
* Optionally, update the make_windows_bundle script. DEPRECATED.

0 commit comments

Comments
 (0)