Skip to content

Commit

Permalink
Update github_actions.md
Browse files Browse the repository at this point in the history
Improved grammar and clarity
  • Loading branch information
lsloan authored Sep 14, 2023
1 parent 8204866 commit 7ef1398
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/github_actions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[Back to README](../README.md)

## Github Action
1. The [github action](https://docs.github.com/en/actions/quickstart) configuration will build Dockerfile and pushes the artifacts to [Github container registry(GHCR)](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry)
2. The build is done whenever a commit is made to master branch
3. [Openshift](https://docs.openshift.com/container-platform/4.11/openshift_images/image-streams-manage.html#images-imagestream-import_image-streams-managing) project will pull this image from GHCR. So configure each non-prod environment myla project to pull the image from the registry
## GitHub Action
1. The [GitHub action](https://docs.github.com/en/actions/quickstart) configuration in [/.github/workflows/main.yml](../.github/workflows/main.yml) uses Dockerfile to build the app, then pushes the artifacts to the [GitHub container registry (GHCR)](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
2. The action is triggered whenever a commit is made to the `master` branch. E.g., when a pull request is merged to `master`.
3. OpenShift projects can periodically pull this image from GHCR. Configure only **_NON-PRODUCTION_** MyLA projects to pull the image
```sh
oc tag ghcr.io/tl-its-umich-edu/my-learning-analytics:latest my-learning-analytics:latest --scheduled
```


See the OpenShift documentation "[Managing image streams: Configuring periodic importing of image stream tags](https://docs.openshift.com/container-platform/4.11/openshift_images/image-streams-manage.html#images-imagestream-import_image-streams-managing)" for details.

0 comments on commit 7ef1398

Please sign in to comment.