Skip to content

feat: add scheduled workflow to sync Paragon icon allow-list - #537

Open
carlos-marquez-wgu wants to merge 1 commit into
openedx:mainfrom
WGU-Open-edX:carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list
Open

carlos-marquez-wgu wants to merge 1 commit into
openedx:mainfrom
WGU-Open-edX:carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list

Conversation

@carlos-marquez-wgu

@carlos-marquez-wgu carlos-marquez-wgu commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Add a weekly GitHub Actions workflow that checks if the @openedx/paragon version used by frontend-app-admin-console has changed, and if so, updates the pinned version and regenerates the vendored icon allow-list via make paragon_icons, then opens a PR with the changes.

Its set to run automatically weekly, at 00:00 on Monday. (let me know if you want a difference cadence, I am re-using the same one of this other action -> https://github.com/openedx/openedx-authz/blob/main/.github/workflows/upgrade-python-requirements.yml)

Refs: ADR-0029

Testing evidence

I forked this repo to my personal account and run the workflow there

Successful workflow run: https://github.com/carlos-marquez-wgu/openedx-authz/actions/runs/38925555767
Here is the PR it created: carlos-marquez-wgu#3

Testing instructions

  1. Fork the repo: https://github.com/openedx/openedx-authz
  2. Clone the new fork to your local machine
  3. Setup additional remote in your local copy
git remote add wgu git@github.com:WGU-Open-edX/openedx-authz.git
  1. Pull this PR tag:
git fetch wgu
git checkout carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list
  1. Push the branch to your fork
# note: change `origin` remote for the remote you are using for your fork if needed
git push -u origin carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list
  1. In your fork, change default branch to carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list temporarily, this way the workflow will appear in the Actions tab
  2. Allow actions to create PRs, go to Settings → Actions → General → Workflow permissions
    Check the box: "Allow GitHub Actions to create and approve pull requests"
  3. Go to Actions tab in your repo, and run your workflow
  4. Verify the workflow ran successfully and a PR was created (see Testing evidence above for an example of how it looks)

Run:
image

PR:
image

Concerns

With the GITHUB_TOKEN used, the PR needs a maintainer to run the CI workflows

image

We will need a PAT token to make it work, I see the workflow at openedx-authz/.github/workflows/upgrade-python-requirements.yml has the token secrets.REQUIREMENTS_BOT_GITHUB_TOKEN, seems this is a valid PAT we can re-use, but wanted maintainers confirmation / direction before using this one, keep the standard GITHUB_TOKEN, create a new PAT for this, or something else. Let me know what you think is best!

Merge checklist:
Check off if complete or not applicable:

  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

AI Usage

Kiro + Claude were used to assist with the creation of the github workflow implementations while throughly and carefully guided, everything was reviewed and corrected manually by an actual person and ensured the changes were up to standard and met the closing issue requirements.

Closes: #528

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 15, 2026
@openedx-webhooks

openedx-webhooks commented Oct 15, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @carlos-marquez-wgu!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Add a weekly GitHub Actions workflow that checks if the @openedx/paragon
version used by frontend-app-admin-console has changed, and if so,
updates the pinned version and regenerates the vendored icon allow-list
via `make paragon_icons`, then opens a PR with the changes.

Refs: ADR 0029
@carlos-marquez-wgu
carlos-marquez-wgu force-pushed the carlos-marquez-wgu/issue-528-scheduled-job-update-paragon-icons-list branch from e5f59bc to c41f116 Compare October 15, 2026 22:28
@carlos-marquez-wgu carlos-marquez-wgu changed the title ci: add scheduled workflow to sync Paragon icon allow-list feat: add scheduled workflow to sync Paragon icon allow-list Oct 15, 2026
@carlos-marquez-wgu
carlos-marquez-wgu marked this pull request as ready for review October 16, 2026 20:43
@carlos-marquez-wgu

Copy link
Copy Markdown
Contributor Author

Hi @openedx/committers-openedx-authz, this PR is ready for reviews

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

Scheduled job to update Paragon icons list for validation

2 participants