githubactions-golang Plugin

    This plugin depends on the following environment variable:

    • GITHUB_TOKEN

    Set it before using this plugin.

    If Docker image build/push is enabled (see the example below), you also need to set the following two environment variables: - DOCKERHUB_USERNAME - DOCKERHUB_TOKEN

    Some parameters are optional. See the default values and optional parameters in the example above.

    Use Together with the github-repo-scaffolding-golang Plugin

    For example, you can first use github-repo-scaffolding-golang to bootstrap a Golang repo, then use this plugin to set up basic GitHub Actions CI workflows. In this scenario:

    • This plugin can specify github-repo-scaffolding-golang as a dependency, so that the dependency is first satisfied before executing this plugin.
    • This plugin can refer to github-repo-scaffolding-golang‘s output to reduce copy/paste human error.

    See the example below:

    1. ---
    2. tools:
    3. - name: github-repo-scaffolding-golang
    4.   instanceID: default
    5.   options:
    6.     owner: IronCore864
    7.     repo: go-webapp-devstream-demo
    9. - name: githubactions-golang
    10.   instanceID: default
    11.   dependsOn: ["github-repo-scaffolding-golang.default"]
    12.   options:
    13.     owner: ${{github-repo-scaffolding-golang.default.outputs.owner}}
    14.     repo: ${{github-repo-scaffolding-golang.default.outputs.repo}}
    15.     language:
    16.       name: go
    17.       version: "1.17"
    18.     branch: main
    19.     build:
    20.     test:
    22.       coverage:
    23.         enable: True
    24.     docker:
    25.       enable: True
    26.       registry:
    27.         type: dockerhub
    28.         username: [[ dockerhubUsername ]]
    29.         repository: ${{github-repo-scaffolding-golang.default.outputs.repo}}
    • We put ggithub-repo-scaffolding-golang.default as dependency by using the dependsOn keyword.
    • We used github-repo-scaffolding-golang.default‘s output as input for the githubactions-golang plugin.

    Pay attention to the ${{ xxx }} part in the example. is the syntax for using an output.