Skip to content

Commit

Permalink
Note automatic workflow deploys the gh-pages site
Browse files Browse the repository at this point in the history
  • Loading branch information
gcapes committed Oct 12, 2022
1 parent f360617 commit 86c2441
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions github-actions/docker.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Github actions
# GitHub actions

## Local action using Docker
## Local actions

A local github action requires an [`action.yml`](action.yml) (in the root directory of the repo) which shows the tool to be used and its inputs and outputs.

## The [Dockerfile](Dockerfile)
## Using a [Dockerfile](Dockerfile)

This needs to copy an [`entrypoint.sh`](entrypoint.sh) file to the container and run it using an `ENTRYPOINT` command. `entrypoint.sh` contains the commands you want to run in the container. This is instead of building the `docker run` command yourself on a command line.

Expand All @@ -16,6 +16,8 @@ This file details which actions trigger the workflow (e.g. push on a named branc

## Deploying html to github pages

Use this [gh-pages-deploy](https://github.com/JamesIves/github-pages-deploy-action) action to deploy the html generated by the workflow. It will commit changes generated by previous steps to your `gh-pages` branch, and render them.
Use this [gh-pages-deploy](https://github.com/JamesIves/github-pages-deploy-action) action to commit the files generated by your workflow to the `gh-pages` branch.

In brief, this step goes at the end of your workflow. [YouTube tutorial](https://youtu.be/jBZfo2Mj1mY)

The actual 'deployment' to your GitHub pages site is done by an automatic workflow called `pages-build-and-deployment`, which is triggered by a push to the `gh-pages` branch.

0 comments on commit 86c2441

Please sign in to comment.