Difference between revisions of "Reviewing Octave Forge packages"
Jump to navigation
Jump to search
(→Checklist: Review list) |
m (→Checklist: Minor addition) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
# 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 passed | + | #* <code>[x]</code> for successfully passed |
| − | #* <code>[ | + | #* <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 | # 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. | # An [https://sourceforge.net/p/octave/_members/ Octave Forge Admin] will try to look over your review and hopefully release the package. | ||
| Line 15: | Line 13: | ||
<pre> | <pre> | ||
| − | # Repository | + | # 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 load foo` | ||
- [ ] `pkg unload foo` | - [ ] `pkg unload foo` | ||
- [ ] `pkg uninstall 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 | # Package files in release candidate tarball | ||
| − | - [ ] `DESCRIPTION` version updated | + | - [ ] `DESCRIPTION` version and release date updated |
- [ ] `DESCRIPTION` minimum Octave tested | - [ ] `DESCRIPTION` minimum Octave tested | ||
- [ ] `DESCRIPTION` all dependencies are listed | - [ ] `DESCRIPTION` all dependencies are listed | ||
| Line 54: | Line 48: | ||
- [ ] (optional if present) `src/configure.ac` version updated | - [ ] (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]] | [[Category:Octave Forge]] | ||
Revision as of 16:56, 18 October 2020
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/
- 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.