HaxeFlixel / HaxeFlixel/flixel-docs
Github Action that triggers `repository_dispatch` on haxeflixel/haxeflixel.com repo
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 86
- Forks
- 132
- PR merge metrics
- No merged PRs in 30d
Description
Right now, the flixel-docs only go live only once the master branch on haxeflixel/haxeflixel.com repo gets either a push, a workflow_dispatch, or a repository_dispatch trigger event. repository_dispatch is something that we can call from outside of that repo via Octokit, so we can use that to build to the site with new documentation whenever a push gets made here, to have more LIVE documentation changes
Contributor guide
No contributing guide indexed for this repository
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
Review the existing GitHub Actions workflow in flixel-docs and the master-branch triggers in haxeflixel/haxeflixel.com. Trace how Octokit could invoke the repository_dispatch entry point after a documentation push. Done means a push here triggers the site workflow and the updated documentation becomes live.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100