PolicyEngine / PolicyEngine/policyengine-core

Migrate GitHub Pages deployment to official actions

Open
#395 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
22
Forks
30
Avg merge
14h 33m
Merged PRs (30d)
7

Description

Current State

This repository currently uses JamesIves/github-pages-deploy-action@releases/v3 for deploying documentation to GitHub Pages (as seen in .github/workflows/push.yaml).

Proposed Change

Migrate to the official GitHub Actions for Pages deployment:

  • actions/configure-pages@v5
  • actions/upload-pages-artifact@v3
  • actions/deploy-pages@v4

Benefits

  • Official GitHub support and maintenance
  • Better integration with GitHub Pages settings
  • Follows GitHub's recommended best practices
  • More reliable and secure

Implementation

Follow the official guide: https://docs.github.com/en/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages

Example implementation: https://github.com/MaxGhenis/disutility-of-uncertainty/pull/2

Required Changes

  1. Add proper permissions to workflow:
permissions:
  contents: read
  pages: write
  id-token: write
  1. Update deployment steps to use official actions
  2. Change GitHub Pages source to "GitHub Actions" in repository settings

This would modernize the deployment pipeline and align with GitHub's current recommendations.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/push.yaml and the linked official GitHub Pages guide. Replace the existing deployment action with the specified Pages actions and permissions, then change the repository Pages source to GitHub Actions; done means the documentation deployment succeeds through the new workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.