Re: [octave forge] releasing

[Andrew Janke]

On 3/24/19 3:14 AM, Olaf Till wrote:
> On Sat, Mar 23, 2019 at 08:27:07PM +0100, Olaf Till wrote:
> > Hint for future reviews: check licenses ('licensecheck -r' plus some
> > manual checks). Change wiki correspondingly?
>
> Other issues to check:
>
> 'pkg' doesn't seem to care for file permissions even in system wide
> installations. So it should be checked that the package files are
> readable/executable by all users. A current maintainer Makefile
> automatically sets the correct permissions in tarball creation so that
> later checking isn't necessary.
>
> Contains no hidden files, results of configure runs, etc.. Again, this
> should be cared for by the maintainer Makefile so that later checking
> isn't necessary.
>
> Version number in src/configure.ac, if this file is present.
>
> Olaf

I've added a "pkj review" command to Packajoozle to do automatable parts 
of package distribution review.

https://github.com/apjanke/octave-packajoozle/issues/31
https://github.com/apjanke/octave-packajoozle/blob/bb9d1af90f2414a25eef821007be3d23f176819a/inst/%2Bpackajoozle/%2Binternal/PkgReviewer.m#L131-L268

You can point it at a package distribution tarball file, a local clone 
of the package repo, or a published Forge package by address@hidden

pkj review image-2.10.0.tar.gz
pkj review /path/to/my/local/clone/of/octave-image
pkj review address@hidden

It'll report any bad findings.

It includes a check for all package files being world readable, that the 
version number in src/configure.ac is present and matches that in 
DESCRIPTION, and that there are no file droppings from configure or 
make. It also checks that installing, loading, unloading, and 
uninstalling the package all work cleanly (that is, they succeed and 
there were no warnings raised).

(To come: running the BIST and doctest unit tests on the package.)

(Olaf, how would you determine which files in the distribution should be 
executable?)

Give it a try if you're interested, and let me know if there are any 
additional checks you'd like done.

Examples:

>> pkj review -verbose io-2.4.12.tar.gz
PkgReviewer: Working dir: 
/var/folders/_4/9mx5ryp52bb_z6drbcbrhwl40000gn/T/packajoozle/pkj-review/work-sB33Cr
PkgReviewer: Reviewing io 2.4.12 from file io-2.4.12.tar.gz
PkgReviewer: Examining distribution file contents
PkgReviewer: Installing package
Installed io 2.4.12 from 
/var/folders/_4/9mx5ryp52bb_z6drbcbrhwl40000gn/T/packajoozle/pkj-review/work-sB33Cr/io-2.4.12.tar.gz 
to user pkg dir
For information about changes from previous versions of the io package, 
run 'news io'.
PkgReviewer: Loading package
pkj: loading: io 2.4.12
PkgReviewer: Unloading package
PkgReviewer: Uninstalling package
PkgReviewer: All checks finished
Package review failed for io-2.4.12.tar.gz.
Errors:
    Version in configure.ac AC_INIT(...) does not match version in 
DESCRIPTION

>> pkj review -verbose statistics-1.4.0.tar.gz
PkgReviewer: Working dir: 
/var/folders/_4/9mx5ryp52bb_z6drbcbrhwl40000gn/T/packajoozle/pkj-review/work-C7FBeP
PkgReviewer: Reviewing statistics 1.4.0 from file statistics-1.4.0.tar.gz
PkgReviewer: Examining distribution file contents
PkgReviewer: Installing package
warning: doc_cache_create: unusable help text found in file 'gmdistribution'
Installed statistics 1.4.0 from 
/var/folders/_4/9mx5ryp52bb_z6drbcbrhwl40000gn/T/packajoozle/pkj-review/work-C7FBeP/statistics-1.4.0.tar.gz 
to user pkg dir
For information about changes from previous versions of the statistics 
package, run 'news statistics'.
PkgReviewer: Loading package
pkj: loading: io 2.4.12, statistics 1.4.0
PkgReviewer: Unloading package
PkgReviewer: Uninstalling package
PkgReviewer: All checks finished
Package review failed for statistics-1.4.0.tar.gz.
Errors:
    Warnings during package installation: doc_cache_create: unusable 
help text found in file 'gmdistribution'

Cheers,
Andrew