Master de II. ULL. 1er cuatrimestre
Read the article Using GitHub CLI in workflows. You can script with GitHub CLI in GitHub Actions workflows.
GitHub CLI is preinstalled on all GitHub-hosted runners. For each step that uses GitHub CLI, you must set an environment variable called GITHUB_TOKEN to a token with the required scopes.
You can execute any GitHub CLI command.
For example, this workflow uses the gh issue comment subcommand to add a comment when an issue is opened.
1
2
3
4
5
6
7
8
9
10
11
12
13
name: Comment when opened
on:
issues:
types:
- opened
jobs:
comment:
runs-on: ubuntu-latest
steps:
- run: gh issue comment $ISSUE --body "Thank you for opening this issue!"
env:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
ISSUE: ${{ github.event.issue.html_url }}
See
htm_url property is a string that contains the HTML URL of the issue comment.Here is the help of gh issue comment:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
➜ gh-repo-rename-testing git:(main) ✗ gh help issue comment
Create a new issue comment
USAGE
gh issue comment {<number> | <url>} [flags]
FLAGS
-b, --body string Supply a body. Will prompt for one otherwise.
-F, --body-file file Read body text from file (use "-" to read from standard input)
-e, --editor Add body using editor
-w, --web Add body in browser
INHERITED FLAGS
--help Show help for command
-R, --repo [HOST/]OWNER/REPO Select another repository using the [HOST/]OWNER/REPO format
EXAMPLES
$ gh issue comment 22 --body "I was able to reproduce this issue, lets fix it."
LEARN MORE
Use 'gh <command> <subcommand> --help' for more information about a command.
Read the manual at https://cli.github.com/manual
Véase:
1
➜ gh-cli-graphql-casiano-rodriguez-leon-alumnoudv5 git:(as-module) cat .github/workflows/npm-publish.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
name: Npm publish repo-rename
on:
push:
branches: [as-module]
jobs:
publish-npm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish --access=public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
test-gh-rename-repo:
needs: publish-npm
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2 # esta action descarga el repo en la máquina virtual
- name: Install node
uses: actions/setup-node@v1
with:
node-version: '16'
- name: See what version of gh is installed
run: gh version
- name: Install gh repo-rename extension. Repo is now public
run: gh extension install ${OWNER}/gh-repo-rename
- name: create repo with user as owner
run: gh api /user/repos -X POST --field name=${OLDNAME}
continue-on-error: true
- name: probar a renombrarlo
run: gh repo-rename -o ${OWNER} -r ${OLDNAME} -n ${NEWNAME}
- name: delete repo
run: gh api -X DELETE "/repos/${OWNER}/${NEWNAME}"
env:
GITHUB_TOKEN: ${{secrets.ACCESS_TOKEN}}
# Instead of crguezl. To make it more generic
OWNER: ${{ github.repository_owner }}
OLDNAME: "prueba"
NEWNAME: "pruebanuevo"
gh extension install ULL-MII-SYTWS-2122/gh-repo-rename no requiera de autenticaciones adicionalesjobs.<job_id>.steps[*].continue-on-error Prevents a job from failing when a step fails.
Set to true to allow a job to pass when this step fails.You can also execute API calls through GitHub CLI. For example, this workflow
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
name: Report remaining open issues
on:
schedule:
# Daily at 8:20 UTC
- cron: '20 8 * * *'
jobs:
track_pr:
runs-on: ubuntu-latest
steps:
- run: |
numOpenIssues="$(gh api graphql -F owner=$OWNER -F name=$REPO -f query='
query($name: String!, $owner: String!) {
repository(owner: $owner, name: $name) {
issues(states:OPEN){
totalCount
}
}
}
' --jq '.data.repository.issues.totalCount')"
echo 'NUM_OPEN_ISSUES='$numOpenIssues >> $GITHUB_ENV
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OWNER: ${{ github.repository_owner }}
REPO: ${{ github.event.repository.name }}
- run: |
gh issue create --title "Issue report" --body "$NUM_OPEN_ISSUES issues remaining" --repo $GITHUB_REPOSITORY
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
This is the help for gh create issue:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
➜ gh-repo-rename-testing git:(main) gh help issue create
Create a new issue
USAGE
gh issue create [flags]
FLAGS
-a, --assignee login Assign people by their login. Use "@me" to self-assign.
-b, --body string Supply a body. Will prompt for one otherwise.
-F, --body-file file Read body text from file (use "-" to read from standard input)
-l, --label name Add labels by name
-m, --milestone name Add the issue to a milestone by name
-p, --project name Add the issue to projects by name
--recover string Recover input from a failed run of create
-t, --title string Supply a title. Will prompt for one otherwise.
-w, --web Open the browser to create an issue
INHERITED FLAGS
--help Show help for command
-R, --repo [HOST/]OWNER/REPO Select another repository using the [HOST/]OWNER/REPO format
EXAMPLES
$ gh issue create --title "I found a bug" --body "Nothing works"
$ gh issue create --label "bug,help wanted"
$ gh issue create --label bug --label "help wanted"
$ gh issue create --assignee monalisa,hubot
$ gh issue create --assignee "@me"
$ gh issue create --project "Roadmap"
LEARN MORE
Use 'gh <command> <subcommand> --help' for more information about a command.
Read the manual at https://cli.github.com/manual