@ghagen/ghagen

GitHub Actions expression helpers.

Variables

Variable Description

Variable	Description
github	Proxy for accessing GitHub context values as expressions. Example `step({ env: { REF: github.ref } }) // produces: REF: "${{ github.ref }}"`
secrets	Proxy for accessing secrets as expressions. Example `step({ env: { TOKEN: secrets.GITHUB_TOKEN } }) // produces: TOKEN: "${{ secrets.GITHUB_TOKEN }}"`
vars	Proxy for accessing environment variable expressions. Example step({ run: `echo ${vars.MY_VAR}` }) // produces: run: "echo ${{ vars.MY_VAR }}"

Proxy for accessing GitHub context values as expressions.

Example

step({ env: { REF: github.ref } })
// produces: REF: "${{ github.ref }}"

Proxy for accessing secrets as expressions.

Example

step({ env: { TOKEN: secrets.GITHUB_TOKEN } })
// produces: TOKEN: "${{ secrets.GITHUB_TOKEN }}"

Proxy for accessing environment variable expressions.

Example

step({ run: `echo ${vars.MY_VAR}` })
// produces: run: "echo ${{ vars.MY_VAR }}"

Function	Description
expr	Tagged template literal for GitHub Actions expressions. Example step({ if_: expr`github.ref == 'refs/heads/main'` }) // produces: if: "${{ github.ref == 'refs/heads/main' }}"