Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the renderer for the restructuring of PG in openwebwork/pg#709 #7

Merged
merged 1 commit into from
May 22, 2023

Conversation

drgrice1
Copy link
Member

@drgrice1 drgrice1 commented Aug 20, 2022

The WeBWorK::PG module is now part of PG, and PG has its own environment so the webwork2 WeBWorK::PG module (and its derivatives) have been removed.

The WeBWorK::Constants, WeBWorK::Debug, and WeBWork::CourseEnvironment modulesa and the webwork2 conf files are no longer needed and so are removed. The renderer uses the WeBWorK::PG::Environment module which is part of PG. Note that this adds one minor installation step for the renderer. The file renderer/conf/pg_config.yml must be copied to renderer/lib/PG/conf. Usually that file will work as is, but in some cases administrators may want to make changes to it. For example, the externalPrograms are the standard linux executables and in the standard locations. On some systems those may need to be changed.

Most of the WeBWorK::Utils module has been removed. All that is left is the two methods that the renderer uses.

In addition the renderer lib directory has been flattened. lib/WeBWorK/lib/WeBWorK is now just lib/WeBWorK. With this (among other things) the WEBWORK_ROOT environment variable is not needed. Note that $WeBWorK::Constants::PG_DIRECTORY is not available. $ENV{PG_ROOT} is used instead in the renderer code.

Note that the unnecessary encoding and decoding of perl warnings has been removed.

Also note that the references to drdrew42 have been changed to openwebwork.

@drgrice1 drgrice1 requested a review from drdrew42 as a code owner August 20, 2022 11:04
@drgrice1
Copy link
Member Author

Note that this should not be merged until after the referenced pg pull request, and the git submodule will need to be updated before this is merged.

Also, we need to discuss the state of this repository in relation to the PG 2.17 release. Currently the develop branch is up to date to work with PG 2.17. The main branch is set to work with PG 2.16. This pull request (if merged) will take the develop branch past the PG 2.17 release. So should develop be merged into main, and a "release" made to match PG 2.17 and tag the current commit in main for PG 2.16?

@drgrice1 drgrice1 force-pushed the pg-environment-work branch 16 times, most recently from 4ec2614 to a6bd912 Compare August 21, 2022 16:37
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 3 times, most recently from c5aec52 to 496e77f Compare September 9, 2022 23:31
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 9 times, most recently from 6495bc5 to 8801a38 Compare September 18, 2022 21:27
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 2 times, most recently from 8c72c35 to 351f7e7 Compare September 19, 2022 11:50
@drgrice1 drgrice1 mentioned this pull request Sep 21, 2022
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 2 times, most recently from 76395e7 to f31362a Compare September 22, 2022 19:57
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 3 times, most recently from 72e9bbf to ab80799 Compare October 12, 2022 19:38
@drgrice1 drgrice1 force-pushed the pg-environment-work branch from ab80799 to dbedb41 Compare October 27, 2022 16:38
@drgrice1 drgrice1 force-pushed the pg-environment-work branch 2 times, most recently from 8e62047 to bb7b04f Compare February 28, 2023 00:42
@drgrice1
Copy link
Member Author

This is now updated to work with the current develop branch of PG. Note that the updated renderer/conf/pg_config.yml file must be copied to renderer/lib/PG/conf (or your existing copy updated).

The WeBWorK::PG module is now part of PG, and PG has its own environment
so the webwork2 WeBWorK::PG module (and its derivatives) have been
removed.

The WeBWorK::Constants, WeBWorK::Debug, and WeBWork::CourseEnvironment
modules and the webwork2 conf files are no longer needed and so are
removed.  The renderer uses the WeBWorK::PG::Environment module which is
part of PG.  Note that this adds one minor installation step for the
renderer.  The file conf/pg_config.yml must be copied to lib/PG/conf.
Usually that file will work as is, but in some cases administrators may
want to make changes to it.  For example, the externalPrograms are the
standard linux executables and in the standard locations.  On some
systems those may need to be changed.

Most of the WeBWorK::Utils module has been removed.  All that is left is
the two methods that the renderer uses.

In addition the renderer lib directory has been flattened.
lib/WeBWorK/lib/WeBWorK is now just lib/WeBWorK.  With this (among other
things) the WEBWORK_ROOT environment variable is not needed.  Note that
$WeBWorK::Constants::PG_DIRECTORY is not available.  $ENV{PG_ROOT} is
used instead in the renderer code.

Note that the unnecessary encoding and decoding of perl warnings has
been removed.

Also note that the references to drdrew42 have been changed to
openwebwork.
Copy link
Member

@drdrew42 drdrew42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@drdrew42 drdrew42 merged commit 673c76d into openwebwork:develop May 22, 2023
@drgrice1 drgrice1 deleted the pg-environment-work branch May 25, 2023 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants