Skip to content

Conversation

@Ang-m4
Copy link

@Ang-m4 Ang-m4 commented May 27, 2025

Description

This pull request introduces the initial implementation of the paragon build-tokens CLI command within the Tutor plugin ecosystem. It leverages a lightweight Docker container and Tutor's custom job framework to facilitate the building of Paragon design tokens.

Key Changes

Docker and Build Process

  • Dockerfile (paragon-builder): Added a Dockerfile for the Paragon Builder, which uses a Node.js Alpine base image to install the Paragon CLI and execute theme builds.
  • Entrypoint Script (entrypoint.sh): Added a script to handle argument parsing and the theme compilation, it integrates with tutor jobs execution framework.
  • Docker Compose Service: Added a paragon-builder-job service in local-docker-compose-jobs-services to run theme builds as Docker-based jobs.

Command Execution

  • Custom Tutor Command: Registered a custom do command (build_tokens) in plugin.py to enable the flexible theme building via the Tutor CLI. This command supports options for source-only builds, token references, specific themes, and verbose logging.

Usage Instructions

  1. Build the Docker Image:
    After installing and enabling the plugin, build the Docker image with the following command:

    tutor images build paragon-builder
  2. Run the Build Job:
    Execute the build job using:

    tutor local do build-tokens <options>

    Note: A comprehensive list of available options for the build-tokens command can be found in the README.rst file.

@Ang-m4 Ang-m4 requested a review from Alec4r May 27, 2025 19:53
@Ang-m4 Ang-m4 force-pushed the afg/tutor-paragon-imp branch from 4c7a107 to 877bbdb Compare May 27, 2025 20:03
@Ang-m4 Ang-m4 force-pushed the afg/tutor-paragon-imp branch from 877bbdb to c8bf872 Compare May 28, 2025 19:20
@Ang-m4 Ang-m4 changed the base branch from dam/plugin_scaffolding to main May 28, 2025 19:21
@Ang-m4
Copy link
Author

Ang-m4 commented May 28, 2025

This PR is already under review right here: openedx#34

@Ang-m4 Ang-m4 closed this May 28, 2025
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.

3 participants