Devcontainer improvements (#1003)

* Update devcontainer and related templates

* update core commit

* update changelog

* update build process to only update hash when deploying

* format

* flake

Author: oscarlevin

CHANGELOG.md

@@ -9,6 +9,11 @@ Instructions: Add a subsection under `[Unreleased]` for additions, fixes, change
 
 ## [Unreleased]
 
+
+### Changed
+
+- Default devcontainer setup now uses a simplified, versioned `pretext-full` docker image.
+
 ### Fixed
 
 - Fill-in-the-blank questions do not need dynamic-subs assets for HTML-format builds; now they will no longer be generated.
@@ -17,6 +22,7 @@ Instructions: Add a subsection under `[Unreleased]` for additions, fixes, change
 
 - Sometimes something goes wrong with the pretext resources in `~/.ptx`.  You can now run `pretext init --system` to reinstall these resources for the current version.  This will also try to run `npm install` for the css themes.
 
+
 ## [2.19.3] - 2025-06-14
 
 Includes updates to core through commit: [1b65b63](https://github.com/PreTeXtBook/pretext/commit/1b65b63c3a83292c22b46cf1e12795c4dd519cc0)

pretext/__init__.py

@@ -18,7 +18,8 @@
 
 VERSION = get_version("pretext", Path(__file__).parent.parent)
 
-CORE_COMMIT = "2721dfdb393bcc2e66f7c07f279c81d132b7a75f"
+
+CORE_COMMIT = "1ef97c03fda832b25d60d78edfbc729ee3a75683"
 
 
 def activate() -> None:

pretext/constants.py

@@ -228,25 +228,23 @@
     "requirements.txt": Path("requirements.txt"),
     "pretext-cli.yml": Path(".github", "workflows", "pretext-cli.yml"),
     "pretext-deploy.yml": Path(".github", "workflows", "pretext-deploy.yml"),
-    "installPretext.sh": Path(".devcontainer", "installPretext.sh"),
     "installPandoc.sh": Path(".devcontainer", "installPandoc.sh"),
-    "installLatex.sh": Path(".devcontainer", "installLatex.sh"),
     "installSage.sh": Path(".devcontainer", "installSage.sh"),
 }
 
 DEPRECATED_PROJECT_RESOURCES = {
     "deploy.yml": Path(".github", "workflows", "deploy.yml"),
     "test-build.yml": Path(".github", "workflows", "test-build.yml"),
     ".devcontainer.json": Path(".devcontainer.json"),
+    "installPretext": Path(".devcontainer", "installPretext"),
+    "installLatex": Path(".devcontainer", "installLatex"),
 }
 
 GIT_RESOURCES = [
     ".gitignore",
     "pretext-cli.yml",
     "pretext-deploy.yml",
     "devcontainer.json",
-    "installPretext.sh",
     "installPandoc.sh",
-    "installLatex.sh",
     "installSage.sh",
 ]

pretext/resources/resource_hash_table.json

@@ -274,15 +274,13 @@
     "installSage.sh": "d167efbf07ea099aba56864e21eeb7c13462203d0a38cafbbef15e34379732de"
   },
   "2.19.4": {
-    "project.ptx": "2dc2900025b5cd39b0f7c8890c1debc2cf2102875bed5b3634aa0e9b151b1711",
-    "codechat_config.yaml": "89dc598ea7db1c91ec8882e2737aff9d683d7123187c288e16f1617a39f9d9e3",
-    ".gitignore": "721a3a2c412782db41cb72441eaef2b9bffdb6d927fde87f67ada1f44a78af90",
-    "devcontainer.json": "5695d90f4194164b092038133b6675544c81d5ea2cf4c5eeec8075e26890998d",
-    "pretext-cli.yml": "e2d6d3a23cd2a955c998ec5cb4005d4cd67cc3d3a2cafc6af618bf5ce0b64009",
-    "pretext-deploy.yml": "4aa427a79fac24030f5a21f49a0a75c333f62f2c0bd44d2d403126eaca0e8ea3",
-    "installPretext.sh": "99676bf6224335cd1dfd8efebd0835ce255366bf3aa10d04388d5fda8134a44e",
-    "installPandoc.sh": "67f9a2418ca80b79fa796d31c77b6f230dba4a496021c6fcf39b67ddba35f013",
-    "installLatex.sh": "51905c51e0b3c95121caab413de37b670aedf712f432bfcdd38c1fe8f312dbc6",
-    "installSage.sh": "1c4b41cba70577b78552884755674fcc91cb2a039aafa63915fc6e7b7165345f"
+    "project.ptx": "9b85a183aec4e47d18ccf02f96da22243398e70a431d0c9ea161f4366b63f838",
+    "codechat_config.yaml": "5ddce213cc31a32747455c07c750b3909779f7877884921eb51e1f4568cab4b7",
+    ".gitignore": "227d5cda5d8b21cf6f92adf3a0b186ecd106e7595c280b30378e98caf87c3116",
+    "devcontainer.json": "17e819d3753a69b8462011c46431ade2fc12e3d56c338ec6236426be0f9fae5e",
+    "pretext-cli.yml": "cad032873daa6663b46224234876664f70482903a3f8165a56be098521aff239",
+    "pretext-deploy.yml": "25857a8fff8bdc7a77db07a1d5745faffe1e1954f32037fe658431f3d30aa9e7",
+    "installPandoc.sh": "dad9b628ac453a8ae45ce78f5228cf2ea6413f12e33194abe249ea2f69f60d35",
+    "installSage.sh": "75e746217f7459f62d140a82a20bbf7e7be094e0d68aeabfaed9fca6efa95476"
   }
 }

scripts/build_package.py

@@ -9,7 +9,7 @@ def main() -> None:
     arguments = sys.argv[1:]
     print(f"Building package for version {pretext.VERSION}.")
     # ensure up-to-date "static" resources
-    fetch_core.main(arguments)
+    fetch_core.main(arguments, update_templates=True)
 
     # Build package
     subprocess.run(["poetry", "build"], shell=True)

scripts/bundle_resources.py

@@ -34,6 +34,13 @@ def resource_hashes() -> None:
                         r"PreTeXt \d+\.\d+\.\d+", f"PreTeXt {VERSION}", line
                     )
                     f.write(new_line)
+                elif '"image": "oscarlevin/pretext' in line:
+                    new_line = re.sub(
+                        r'("image": "oscarlevin/pretext(-full)?):latest"',
+                        rf'\1:{VERSION}"',
+                        line,
+                    )
+                    f.write(new_line)
                 else:
                     f.write(line)
         # Now hash the updated file to add to a hash-table for this version
@@ -53,9 +60,12 @@ def resource_hashes() -> None:
     )
 
 
-def main() -> None:
+def main(update_templates: bool = False) -> None:
     # Take care of boilerplate files and their hashes
-    resource_hashes()
+    if update_templates:
+        resource_hashes()
+    else:
+        print("Skipping resource hash generation.")
 
     # Zip the templates and pelican resources
     shutil.make_archive(

scripts/fetch_core.py

@@ -51,10 +51,8 @@ def get_runestone_services() -> None:
             zip_ref.write(rs_services_tgz_path, arcname=services_file_name)
 
 
-def main(args=None) -> None:
-    print(args)
+def main(args: any = None, update_templates: bool = False) -> None:
     if args:
-        print(f"Arguments: {args}")
         repo_name = args[0]
     else:
         repo_name = "PreTeXtBook/pretext"
@@ -127,7 +125,7 @@ def main(args=None) -> None:
     # Get Runestone services file
     get_runestone_services()
 
-    bundle_resources.main()
+    bundle_resources.main(update_templates=update_templates)
     print("Successfully bundled core PreTeXtBook/pretext resources.")
 
 

templates/devcontainer.json

@@ -1,4 +1,4 @@
-// This file was automatically generated with PreTeXt 2.19.4.
+// This file was automatically generated with PreTeXt 2.19.3.
 // If you modify this file, PreTeXt will no longer automatically update it.
 //
 //////////////////////////////////////////////////////////////
@@ -13,15 +13,15 @@
 //
 ///////////////////////////////////////////////////////////////
 {
-  "image": "mcr.microsoft.com/devcontainers/universal:2",
+  "image": "oscarlevin/pretext-full:latest",
+  // If you don't need sagemath, you can use a smaller base image.  Comment out the line above and uncomment the line below to use a smaller image.
+  // "image": "oscarlevin/pretext:latest",
   "features": {},
 
-  // Comment or uncomment lines below if you don't or do need that feature.
+  // The pretext-full image above includes pretext, prefigure, and enough parts of latex and sagemath for most cases.  If there are errors with sage, you can install the full sagemath package through Conda by running ./.devcontainer/installSage.sh, or uncommenting that line and rebuilding the container.
   "postCreateCommand": {
     // "install sagemath": "bash ./.devcontainer/installSage.sh",
     "install pandoc": "bash ./.devcontainer/installPandoc.sh",
-    "install latex": "bash ./.devcontainer/installLatex.sh",
-    "install pretext": "bash ./.devcontainer/installPretext.sh",
     "mark repo as safe": "git config --global --add safe.directory $(pwd)"
     },