Introduction to GitHub Actions
11 likes20,344 views
The document provides an introduction to GitHub Actions and details its integration with CI/CD platforms, including a workflow for deploying applications using SSH commands. It highlights the usage of secrets for security and addresses issues related to workflows and logging. Additionally, it offers guidance on creating and publishing GitHub actions, including necessary configurations and example actions by the author.
![workflow "Remote ssh commands" {
on = "push"
resolves = [
"Remote ssh commands",
]
}
main.workflow](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-14-320.jpg)
![action "Remote ssh commands" {
uses = "appleboy/ssh-action@master"
secrets = [
"HOST",
"PASSWORD",
]
args = [
"--user", "actions",
"--script", "whoami",
]
}
main.workflow](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-15-320.jpg)
![Scheduling a workflow
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
│ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * *
workflow "New workflow" {
on = "schedule(*/15 * * * *)"
resolves = ["Hello World"]
}](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-18-320.jpg)
![action "Remote ssh commands" {
uses = "appleboy/ssh-action@master"
secrets = [
"HOST",
"PASSWORD",
]
args = [
"--user", "actions",
"--script", "whoami",
]
}
main.workflow](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-26-320.jpg)
![main.workflow
secrets = [
"PASSWORD",
]
args = [
"--user", "actions",
"--script", "whoami",
]
secrets = [
"PASSWORD",
]
args = [
"--user", "actions",
"--script", "whoami",
]
Server 01 Server 02
docker run -e PASSWORD=xxx appleboy/drone-ssh
-u actions -s whoami](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-31-320.jpg)
![main.workflow
secrets = [
"PASSWORD01",
]
args = [
"-p", "$PASSWORD01",
"--script", "whoami",
]
secrets = [
"PASSWORD02",
]
args = [
"-p", "$PASSWORD02",
"--script", "whoami",
]
Server 01 Server 02](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-32-320.jpg)
![action "Publish" {
needs = "Tag"
uses = "actions/npm@master"
args = "publish --access public"
secrets = ["NPM_AUTH_TOKEN"]
}
https://github.com/actions/npm](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-33-320.jpg)
![FROM appleboy/drone-ssh:1.5.0-linux-amd64
# Github labels
LABEL "com.github.actions.name"="SSH Commands"
LABEL "com.github.actions.description"="some description"
LABEL "com.github.actions.icon"="terminal"
LABEL “com.github.actions.color"="gray-dark"
LABEL "repository"="https://github.com/appleboy/ssh-action"
LABEL "homepage"="https://github.com/appleboy"
LABEL "maintainer"="Bo-Yi Wu <appleboy.tw@gmail.com>"
LABEL "version"="0.0.1"
ADD entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-40-320.jpg)
![action "Tag Docker Image" {
needs = ["build"]
uses = "actions/docker/cli@master"
args = "tag hello:$GITHUB_SHA"
}](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-43-320.jpg)
![action "Tag Docker Image" {
needs = ["build"]
uses = "actions/docker/cli@master"
args = ["tag", "hello:$GITHUB_SHA"]
}](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-44-320.jpg)
![FROM appleboy/drone-ssh:1.5.0-linux-amd64
# Github labels
LABEL "com.github.actions.name"="SSH Commands"
LABEL "com.github.actions.description"="some description"
LABEL "com.github.actions.icon"="terminal"
LABEL “com.github.actions.color"="gray-dark"
LABEL "repository"="https://github.com/appleboy/ssh-action"
LABEL "homepage"="https://github.com/appleboy"
LABEL "maintainer"="Bo-Yi Wu <appleboy.tw@gmail.com>"
LABEL "version"="0.0.1"
ADD entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
please make sure that there is no problem with Dockerfile in LABEL](https://image.slidesharecdn.com/github-actions-190516015900/85/Introduction-to-GitHub-Actions-51-320.jpg)
Introduction to GitHub Actions
- 1. Introduction to GitHub Actions2019/05/15 Bo-Yi Wu https://github.com/appleboy
- 2. About me • Software Engineer in Mediatek • Member of Drone CI/CD Platform • Member of Gitea Platform • Member of Gin Golang Framework • Teacher of Udemy Platform: Golang + Drone https://blog.wu-boy.com
- 3. GitHub Flow 14 Develop Git Push Git Tag Develop Git Push Git Tag Testing Deploy Deploy Deploy Production Staging Production Testing Deploy Staging
- 4. GitHub Flow + Git Flow in opensource https://github.com/go-gitea/gitea
- 5. CI/CD Platform Drone Travis Jenkins GitLab Circle Codeship
- 10. Current runtime resource • 1 virtual CPU • Up to 3.75GB of memory • 100GB of disk space
- 11. 28Events
- 13. |-- hello-world (repository) | |__ .github | |__ main.workflow |
- 14. workflow "Remote ssh commands" { on = "push" resolves = [ "Remote ssh commands", ] } main.workflow
- 15. action "Remote ssh commands" { uses = "appleboy/ssh-action@master" secrets = [ "HOST", "PASSWORD", ] args = [ "--user", "actions", "--script", "whoami", ] } main.workflow
- 17. Download the docker image for caching Cache layer http://bit.ly/docker-cache-build
- 18. Scheduling a workflow ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) │ │ │ ┌───────────── month (1 - 12 or JAN-DEC) │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ * * * * * workflow "New workflow" { on = "schedule(*/15 * * * *)" resolves = ["Hello World"] }
- 19. What’s problem in UI?
- 20. You can’t see the log in progress job
- 22. But you can’t restart the job http://www.thebrokeagent.com/wtf-listing-description-of-the-week/
- 23. $ git reset —soft HEAD^ $ git commit -a -m ‘foo’ $ git push origin master -f Restart the job
- 24. Secrets in Github Actions Setting -> Secrets in left sidebar
- 26. action "Remote ssh commands" { uses = "appleboy/ssh-action@master" secrets = [ "HOST", "PASSWORD", ] args = [ "--user", "actions", "--script", "whoami", ] } main.workflow
- 27. What’s problem in Secrets?
- 28. Don’t support organization secrets duplicate of secrets in many repository of organization
- 29. Don’t support thirty party secret service
- 30. You need to write CLI flag in command drone-ssh -u foo -p foopass -s whoami drone-ssh -u bar -p barpass -s whoami
- 31. main.workflow secrets = [ "PASSWORD", ] args = [ "--user", "actions", "--script", "whoami", ] secrets = [ "PASSWORD", ] args = [ "--user", "actions", "--script", "whoami", ] Server 01 Server 02 docker run -e PASSWORD=xxx appleboy/drone-ssh -u actions -s whoami
- 32. main.workflow secrets = [ "PASSWORD01", ] args = [ "-p", "$PASSWORD01", "--script", "whoami", ] secrets = [ "PASSWORD02", ] args = [ "-p", "$PASSWORD02", "--script", "whoami", ] Server 01 Server 02
- 33. action "Publish" { needs = "Tag" uses = "actions/npm@master" args = "publish --access public" secrets = ["NPM_AUTH_TOKEN"] } https://github.com/actions/npm
- 34. How to add multiple auth token of npm registry?
- 35. kind: pipeline name: default steps: - name: build image: appleboy/drone-ssh environment: USERNAME: from_secret: username PASSWORD: from_secret: password
- 37. |-- ssh-action (repository) | |__ .github | |__ main.workflow | |__ Dockerfile | |__ entrypoint.sh | |__ README.md | |__ LICENSE
- 38. Support any language you want
- 39. Dockerfile
- 40. FROM appleboy/drone-ssh:1.5.0-linux-amd64 # Github labels LABEL "com.github.actions.name"="SSH Commands" LABEL "com.github.actions.description"="some description" LABEL "com.github.actions.icon"="terminal" LABEL “com.github.actions.color"="gray-dark" LABEL "repository"="https://github.com/appleboy/ssh-action" LABEL "homepage"="https://github.com/appleboy" LABEL "maintainer"="Bo-Yi Wu <[email protected]>" LABEL "version"="0.0.1" ADD entrypoint.sh /entrypoint.sh RUN chmod +x /entrypoint.sh ENTRYPOINT ["/entrypoint.sh"]
- 41. entrypoint.sh
- 42. #!/bin/sh set -eu export GITHUB="true" sh -c "/bin/drone-ssh $*"
- 43. action "Tag Docker Image" { needs = ["build"] uses = "actions/docker/cli@master" args = "tag hello:$GITHUB_SHA" }
- 44. action "Tag Docker Image" { needs = ["build"] uses = "actions/docker/cli@master" args = ["tag", "hello:$GITHUB_SHA"] }
- 46. action "Hello World" { uses = "./my-action" env = { FIRST_NAME = "Mona" MIDDLE_NAME = "Lisa" LAST_NAME = "Octocat" } }
- 48. GitHub Variable • GITHUB_WORKFLOW • GITHUB_ACTION • GITHUB_EVNETNAME • GITHUB_SHA • GITHUB_REF
- 49. I don’t know how to get the author email, name or commit message Resolve this problem using GitHub API request?
- 50. Publishing your action in the GitHub Marketplace
- 51. FROM appleboy/drone-ssh:1.5.0-linux-amd64 # Github labels LABEL "com.github.actions.name"="SSH Commands" LABEL "com.github.actions.description"="some description" LABEL "com.github.actions.icon"="terminal" LABEL “com.github.actions.color"="gray-dark" LABEL "repository"="https://github.com/appleboy/ssh-action" LABEL "homepage"="https://github.com/appleboy" LABEL "maintainer"="Bo-Yi Wu <[email protected]>" LABEL "version"="0.0.1" ADD entrypoint.sh /entrypoint.sh RUN chmod +x /entrypoint.sh ENTRYPOINT ["/entrypoint.sh"] please make sure that there is no problem with Dockerfile in LABEL
- 52. Create New Tag and Publish Release
- 54. Some action I created • appleboy/ssh-action • appleboy/scp-action • appleboy/facebook-action • appleboy/telegram-action • appleboy/jenkins-action • appleboy/gitlab-ci-ation • appleboy/discord-action
- 57. Thank You