Github workflow hooks
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 1k
- Forks
- 144
- Avg merge
- 7d 14h
- Merged PRs (30d)
- 2
Description
I'd like to set up the docs to:
- build and deploy when I push to
masterat ajfriend/h3-py- so that I can preview at ajfriend.github.io/h3-py
- build and deploy when changes get landed to
masteron uber/h3-py- so that the latest docs get deployed at uber.github.io/h3-py
- ideally this would only be through PRs, yeah?
- build (but do not deploy**) on PRs to uber/h3-py
so that we can confirm that the docs build without errors before landing
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 by inspecting the existing documentation build configuration and GitHub workflow setup in ajfriend/h3-py and uber/h3-py. Verify the three requested paths separately: deploy pushes to the fork, deploy changes landed on uber/h3-py's master, and build-only pull requests; done means the docs build succeeds and the expected GitHub Pages destinations update without deploying PR builds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100