Difference between revisions of "Release notes for WeBWorK 2.19"

From WeBWorK_wiki
Jump to navigation Jump to search
(11 intermediate revisions by the same user not shown)
Line 27: Line 27:
 
* All versions of PGcompoundproblem have been deprecated. Problems should be migrated to scaffold.
 
* All versions of PGcompoundproblem have been deprecated. Problems should be migrated to scaffold.
   
== Upgrade Notes and Cautions ==
+
== Upgrade Instructions ==
+
* First update the webwork2 and pg code. For this run
* New Prerequisites:
+
*: <code>> cd /opt/webwork/webwork2</code>
** Mojolicious::Plugin::RenderFile
+
*: <code>> git fetch origin</code>
* Update site.conf: need to define $admin_course_id
+
*: <code>> git checkout WeBWorK-2.19</code>
* Imagemagick configuration
+
*: <code>> git pull</code>
  +
*: <code>> cd /opt/webwork/pg</code>
  +
*: <code>> git fetch origin</code>
  +
*: <code>> git checkout PG-2.19</code>
  +
*: <code>> git pull</code>
  +
*: '''Note''': Will use the main branches after the release.
  +
* Update the javascript and css assets for webwork2 and pg with
  +
*: <code>> cd /opt/webwork/webwork2/htdocs</code>
  +
*: <code>> npm ci</code>
  +
*: <code>> cd /opt/webwork/pg/htdocs</code>
  +
*: <code>> npm ci</code>
  +
* The following perl packages will need to be installed (run <code>bin/check_modules.pl</code> to ensure you have all programs/modules)
  +
** Archive::Zip::SimpleZip (on Ubuntu install from cpan)
  +
** File::Copy::Recursive (on Ubuntu install libfile-copy-recursive-perl)
  +
** GD::Barcode::QRcode (on Ubuntu install libgd-barcode-perl)
  +
** MIME::Base32 (on Ubuntu install libmime-base32-perl)
  +
** SQL::Abstract (on Ubuntu install libsql-abstract-perl)
  +
* The program ''inkscape'' is needed for conversion of svg to png for hardcopy. This is used indirectly by imagemagick's convert program. The imagemagick program may need special configuration for some operating systems to use inkscape for this. (On Ubuntu install the inkscape package with apt. No further configuration is needed.)
  +
* Compare any files in the <code>/opt/webwork/webwork2/conf</code> directory that have been copied from a .dist file to the updated distribution .dist file, and update as needed.
  +
** In particular make sure that the variable '''$admin_course_id''' is defined in site.conf.
  +
** Note that two factor authentication is enabled for all courses by default. This only affects signing in with a username and password on the login page, and not remote authentication methods. See the '''$twoFA''' variables in localOverrides.conf on how to configure two factor authentication.
  +
** If the setting for '''secrets''' in your webwork2.mojolicious.yml file is the same as that in the webwork2.mojolcious.dist.yml file, then make sure that you change it. That is now used to sign cookies, and would be a security vulnerability to use the default from the distribution.
  +
* Upgrade the admin course by executing the <code>upgrade_admin_db.pl</code> script.
  +
* Make sure to upgrade courses from the admin course to relegate changes to the database.

Revision as of 06:08, 2 May 2024

Construction.png This article is under construction. Use the information herein with caution until this message is removed.
Warning : This page should be considered incomplete until the release of 2.19 has been announced

New WeBWorK Features

  • The attempts table has been removed. Feedback for correct/incorrect answers is now associated directly with each answer blank.
  • PGML native syntax for tables
  • Add a PGML converter to the PG editor
  • Rename the "Hmwk Sets Editor" and "Classlist Editor" to "Sets Manager" and "Accounts Manager"
  • Links to file bugs now go to the appropriate GitHub page.
  • File Manager updates
    • archive and unarchive zip files
    • editing problem files (pg) opens the problem editor.
  • Improvements to the Instructor Tools
    • new sort options on users/sets
  • Redesign of the PGML lab
    • All of the examples have been updated.
    • Now there are examples that include all PGML features.
    • Listing of references

New PG Features

Deprecated Functionality

  • All versions of PGcompoundproblem have been deprecated. Problems should be migrated to scaffold.

Upgrade Instructions

  • First update the webwork2 and pg code. For this run
    > cd /opt/webwork/webwork2
    > git fetch origin
    > git checkout WeBWorK-2.19
    > git pull
    > cd /opt/webwork/pg
    > git fetch origin
    > git checkout PG-2.19
    > git pull
    Note: Will use the main branches after the release.
  • Update the javascript and css assets for webwork2 and pg with
    > cd /opt/webwork/webwork2/htdocs
    > npm ci
    > cd /opt/webwork/pg/htdocs
    > npm ci
  • The following perl packages will need to be installed (run bin/check_modules.pl to ensure you have all programs/modules)
    • Archive::Zip::SimpleZip (on Ubuntu install from cpan)
    • File::Copy::Recursive (on Ubuntu install libfile-copy-recursive-perl)
    • GD::Barcode::QRcode (on Ubuntu install libgd-barcode-perl)
    • MIME::Base32 (on Ubuntu install libmime-base32-perl)
    • SQL::Abstract (on Ubuntu install libsql-abstract-perl)
  • The program inkscape is needed for conversion of svg to png for hardcopy. This is used indirectly by imagemagick's convert program. The imagemagick program may need special configuration for some operating systems to use inkscape for this. (On Ubuntu install the inkscape package with apt. No further configuration is needed.)
  • Compare any files in the /opt/webwork/webwork2/conf directory that have been copied from a .dist file to the updated distribution .dist file, and update as needed.
    • In particular make sure that the variable $admin_course_id is defined in site.conf.
    • Note that two factor authentication is enabled for all courses by default. This only affects signing in with a username and password on the login page, and not remote authentication methods. See the $twoFA variables in localOverrides.conf on how to configure two factor authentication.
    • If the setting for secrets in your webwork2.mojolicious.yml file is the same as that in the webwork2.mojolcious.dist.yml file, then make sure that you change it. That is now used to sign cookies, and would be a security vulnerability to use the default from the distribution.
  • Upgrade the admin course by executing the upgrade_admin_db.pl script.
  • Make sure to upgrade courses from the admin course to relegate changes to the database.