Open marianoa opened 5 years ago
Nice work, you committed a Dockerfile
. You'll notice at the end of the Dockerfile, we refer to an entrypoint script.
ENTRYPOINT ["/entrypoint.sh"]
The entrypoint.sh
script will be run in Docker, and it will define what the action is really going to be doing.
An entrypoint script must exist in our repository so that Docker has something to execute.
./action-a/
directory titled entrypoint.sh
. You can do so with this quicklinkAdd the following content to the entrypoint.sh
file:
#!/bin/sh -l
sh -c "echo Hello world my name is $MY_NAME"
Nice work adding the entrypoint.sh
script. This script will help define the action.
In entrypoint.sh
, all we're doing is outputting a "Hello world" message using an environment variable called MY_NAME
, which we'll define in the next step.
Next, we'll define a workflow that uses the GitHub Action.
Workflows are defined in special files in the .github/workflows
directory, named main.yml
.
Workflows can execute based on your chosen event. For this lab, we'll be using the push
event.
We'll break down each line of the workflow in the next step.
First, we'll add the bones of the workflow. We'll add the action itself in a later step.
.github/workflows/main.yml
. You can do so using this quicklink or manually:
workflows
directory nested inside the .github
directory..github/workflows/
directory, create a file titled main.yml
main.yml
file:
name: A workflow for my Hello World file
on: push
Nice work! :tada: You added a workflow!
Here's what it means:
name: A workflow for my Hello World file
gives your workflow a name. This name appears on any pull request or in the Actions tab. The name is especially useful when there are multiple workflows in your repository.on: push
indicates that your workflow will execute anytime code is pushed to your repository, using the push
event.Next, we need to specify a job or jobs to run.
Workflows piece together jobs, and jobs piece together steps. We'll now create a job that runs an action. Actions can be used from within the same repository, from any other public repository, or from a published Docker container image. We'll use an action that we'll define in this repository.
We'll add the block now, and break it down in the next step.
Let's add the expected action to the workflow.
.github/workflows/main.yml
to append the following content:
jobs:
build:
name: Hello world action
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: ./action-a
env:
MY_NAME: "Mona"
Nice, you just added an action block to your workflow file! Here are some important details about why each part of the block exists and what each part does.
jobs:
is the base component of a workflow runbuild:
is the identifier we're attaching to this jobname:
is the name of the job, this is displayed on GitHub when the workflow is runningsteps:
the linear sequence of operations that make up a jobuses: actions/checkout@master
uses an action called checkout
to use a copy of our code repositoryuses: ./action-a
uses an action named action-a
by referencing the path to the action's directory, relative to our repositoryenv
: is used to specify the environment variables that will be available to your action in the runtime environment. In this case, the environment variable is MY_NAME
, and it is currently initialized to "Mona"
.Your repository now contains everything it needs for the action to be defined (in the ./action-a/
folder) and everything it needs to be triggered (in the ./github/main.yml
file).
The action will run anytime a commit is recognized on the remote repository. Since you just pushed, let's wait for the workflow to be triggered. This might take a few minutes since it's the first time running in this repository.
You can see the action status reported below, or you can click the "Actions" tab in your repository. From there you will see the actions that have run, and you can click on the action's "Log" link to view details.
Actions can take a minute or two to run. Sometimes, I also respond too fast for the page to update! If you don't see a response from your action, wait a few seconds and refresh the page.
Note: This course will only work for members of the GitHub Actions limited public beta. If you're not in the GitHub Actions limited public beta, you won't receive a response from the action.
Adding Dockerfile