Reviewing Octave Forge packages: Difference between revisions

Jump to navigation Jump to search

Reviewing Octave Forge packages (edit)

Revision as of 00:56, 19 October 2020

413 bytes added ,  19 October 2020
m
→‎Checklist: Minor addition
(Update Checklist fill out procedure.)
m (→‎Checklist: Minor addition)
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:


<pre>
<pre>
# Repository
# Repository / Metadata


- [ ] maintainer has specified a corresponding revision commit/changeset
- [ ] release commit/changeset specified and present in repository
- [ ] checkout code from Sourceforge, commit/changeset is present
- [ ] `generate_package_html` / `make html` works without errors and warnings
- [ ] generated HTML documentation looks sane


# Compile and Install
# pkg-tool runs without errors or warnings
 
- [ ] release candidate installs on latest stable Octave release
- [ ] no compiler errors or warnings
- [ ] ran tests using <code>runtests /path/to/pkg</code> (use <code>oruntests</code> instead in Octave 6.0.0 or later)
- [ ] ran all tests, including those in src (how??)
- [ ] ran doctest on all functions (optional)
- [ ] ran generate_package_html (if Makefile present try <code> make html </code>)
- [ ] no makeinfo errors and warnings during HTML build
- [ ] unpacked and spot-checked the generated HTML documentation
 
# `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:
- 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 52: 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]]
Retrieved from "https://wiki.octave.org/Special:MobileDiff/13386...13405"

Navigation menu