Adding a repository dispatch event to apollo repository for docker build.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
Issue
Whenever changes are pushed to the main branch of the docs repo, we need to rebuild the docker image (for the apollo repo) in order to seed the database with the updated docs. This issue needs to be looked into after PR is merged.
Implementation
To achieve this, we can add a step to the already existing workflow to trigger a dispatch event for the apollo repo to re-build the docker image.
We can either do it using the peter-evans/repository-dispatch@v2 or a
curl -X POST -H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
https://api.github.com/repos/OpenFn/apollo/dispatches \
-d '{"event_type":"docs-updated"}
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
First confirm that OpenFn/apollo#86 has been merged, then inspect the existing workflow in the docs repository. Determine how it can send a repository dispatch event to OpenFn/apollo using the proposed action or API request, and verify that a docs update results in the expected Docker rebuild and database seed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, github-actions, javascript
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100