Reviewing Octave Forge packages: Difference between revisions
Jump to navigation
Jump to search
(→Help reviewing Octave-Forge packages: reformat) Tags: Mobile edit Mobile web edit |
m (→Checklist: Minor addition) |
||
(30 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Note|More than one person can review a package, in fact that would be great.}} | |||
The reviewing procedure in short: | |||
# Pick a package at https://sourceforge.net/p/octave/package-releases/ | # Pick a package at https://sourceforge.net/p/octave/package-releases/ | ||
# Copy the check-list below and fill it out, marking each box: | # Copy the check-list below and fill it out, marking each box: | ||
#* <code>[x]</code> for successfully passed | |||
#* <code>[ ]</code> for not done / error (please give below the checklist a brief reason) | |||
# Paste your filled in check-list as a comment on the issue above | |||
# An [https://sourceforge.net/p/octave/_members/ Octave Forge Admin] will try to look over your review and hopefully release the package. | |||
# Paste your filled in check-list as a | |||
== Checklist == | |||
<pre> | |||
# Repository / Metadata | |||
- [ ] release commit/changeset specified and present in repository | |||
- [ ] `generate_package_html` / `make html` works without errors and warnings | |||
- [ ] generated HTML documentation looks sane | |||
# pkg-tool runs without errors or warnings | |||
- [ ] `pkg install foo` | |||
- [ ] `pkg load foo` | |||
- [ ] `pkg unload foo` | |||
- [ ] `pkg uninstall foo` | |||
- Above steps were run on Octave and OS versions: | |||
- ________ | |||
- ________ | |||
# Package tests | |||
- [ ] ran tests (`runtests /path/to/pkg` or `oruntests`) | |||
- [ ] ran `doctest` on all functions | |||
# Package files in release candidate tarball | |||
[ ] | - [ ] `DESCRIPTION` version and release date updated | ||
[ ] | - [ ] `DESCRIPTION` minimum Octave tested | ||
[ ] | - [ ] `DESCRIPTION` all dependencies are listed | ||
[ ] | - [ ] `NEWS` version and date match | ||
- [ ] `NEWS` big changes announced | |||
[ ] | - [ ] `INDEX` all (new) functions are listed | ||
[ ] | - [ ] version numbers in help text and function body (e.g., banners) updated | ||
[ ] | - [ ] license specifications in help text and function body agree `licensecheck -r` | ||
[ ] | - [ ] file permissions are readable/executable by all users | ||
[ ] | - [ ] junk files are removed (hidden dot files, backup files, results of configure runs, etc.) | ||
- [ ] (optional if present) `src/configure.ac` version updated | |||
</pre> | </pre> | ||
== | == Admin tasks == | ||
# Upload release tarball to [https://sourceforge.net/projects/octave/files/Octave%20Forge%20Packages/Individual%20Package%20Releases/ Individual Package Releases] | |||
# Update https://octave.sourceforge.io/ | |||
## Upload new package HTML documentation to {{Path|/home/project-web/octave/htdocs/packages/foo/}} <ref>How to access the Octave Forge webspace [https://sourceforge.net/p/forge/documentation/Project%20Web%20Services/ SourceForge help].</ref> | |||
## Update index | |||
### Add entry in [https://sourceforge.net/p/octave/project-web/ci/default/tree/htdocs/news.html htdocs/news.html] | |||
### Run [https://sourceforge.net/p/octave/project-web/ci/default/tree/admin/ofadmin_update_index.m admin/ofadmin_update_index.m] | |||
== Footnotes == | |||
<references/> | |||
[[Category:Octave Forge]] | |||
Revision as of 00:56, 19 October 2020
The reviewing procedure in short:
- Pick a package at https://sourceforge.net/p/octave/package-releases/
- Copy the check-list below and fill it out, marking each box:
[x]
for successfully passed[ ]
for not done / error (please give below the checklist a brief reason)
- Paste your filled in check-list as a comment on the issue above
- An Octave Forge Admin will try to look over your review and hopefully release the package.
Checklist
# Repository / Metadata - [ ] release commit/changeset specified and present in repository - [ ] `generate_package_html` / `make html` works without errors and warnings - [ ] generated HTML documentation looks sane # pkg-tool runs without errors or warnings - [ ] `pkg install foo` - [ ] `pkg load foo` - [ ] `pkg unload foo` - [ ] `pkg uninstall foo` - Above steps were run on Octave and OS versions: - ________ - ________ # Package tests - [ ] ran tests (`runtests /path/to/pkg` or `oruntests`) - [ ] ran `doctest` on all functions # Package files in release candidate tarball - [ ] `DESCRIPTION` version and release date updated - [ ] `DESCRIPTION` minimum Octave tested - [ ] `DESCRIPTION` all dependencies are listed - [ ] `NEWS` version and date match - [ ] `NEWS` big changes announced - [ ] `INDEX` all (new) functions are listed - [ ] version numbers in help text and function body (e.g., banners) updated - [ ] license specifications in help text and function body agree `licensecheck -r` - [ ] file permissions are readable/executable by all users - [ ] junk files are removed (hidden dot files, backup files, results of configure runs, etc.) - [ ] (optional if present) `src/configure.ac` version updated
Admin tasks
- Upload release tarball to Individual Package Releases
- Update https://octave.sourceforge.io/
- Upload new package HTML documentation to /home/project-web/octave/htdocs/packages/foo/ [1]
- Update index
- Add entry in htdocs/news.html
- Run admin/ofadmin_update_index.m
Footnotes
- ↑ How to access the Octave Forge webspace SourceForge help.