PolicyEngine / PolicyEngine/policyengine-core
Migrate GitHub Pages deployment to official actions
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@v5actions/upload-pages-artifact@v3actions/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
- Add proper permissions to workflow:
permissions:
contents: read
pages: write
id-token: write
- Update deployment steps to use official actions
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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