Read out environment name in github reusable workflow

Question

In our github repository, we have a github action that calls a reusable workflow in an environment.

name: Pull Request Merged

concurrency:
  group: ${{ github.ref }}

on:
  pull_request:
    types: [closed]
  
jobs:
  deploy_to_stage:
    if: |
      github.event.pull_request.merged == true && 
      contains(github.event.pull_request.labels.*.name, 'Stage')
    name: Deploy to Stage
    uses: ./.github/workflows/deploy.yml
    with:
      environment: Stage
    secrets: inherit

The reusable workflow is roughly as follows:

name: deploy
on:
  workflow_call:
    secrets:
      AWS_ACCESS_KEY_ID:
        required: true
      AWS_SECRET_ACCESS_KEY:
        required: true

jobs:
  deployment:
    runs-on: ubuntu-latest
    steps:
[...]

How can I access the value of the environment name (here: "Stage") in a step of the reusable workflow?

It's not possible to get this value from the workflow context. Why not adding an environment input in the reusable workflow receiving the value? Then, you could access it from anywhere in the reusable workflow by using ${{ inputs.environment }}. — GuiFalourd
– GuiFalourd, Commented Nov 17, 2022 at 11:29
@GuiFalourd thanks, I like the idea. If you convert your comment into an answer, I'll happily accept it. — Hermann.Gruber
– Hermann.Gruber, Commented Nov 17, 2022 at 15:43

GuiFalourd · Accepted Answer · 2022-11-17 16:43:23Z

4

It's not possible to get this value from the workflow context.

A workaround could be adding an environment input in the reusable workflow receiving the value:

name: deploy

on:
  workflow_call:
    inputs:
      environment:
        required: true
    secrets:
      AWS_ACCESS_KEY_ID:
        required: true
      AWS_SECRET_ACCESS_KEY:
        required: true

Then, you could access the input value from anywhere in the reusable workflow by using ${{ inputs.environment }}.

answered Nov 17, 2022 at 16:43

GuiFalourd

24.3k8 gold badges84 silver badges106 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

willwrighteng · Accepted Answer · 2022-11-17 11:08:57Z

2

You could use environment secrets to store the stage name within that deployment environment, then access the environment variable within your script (eg bash script) or as a component of the action ${{ env.DAY_OF_WEEK == 'Monday' }} (ref)

answered Nov 17, 2022 at 11:08

willwrighteng

3,1912 gold badges22 silver badges36 bronze badges

4 Comments

Hermann.Gruber Over a year ago

Thank you for your answer! Actually, that's what we already had in place. But I don't like the fact that the variables are treated as secret whereas they can be public. This makes outputs etc. less readable, and renders it unnecessarily difficult to understand for those who don't know the value of the secret.

user2189998 Over a year ago

Since a few weeks Github has a new functionality for environments variables that can be used for that.

Hermann.Gruber Over a year ago

@user2189998 thank you for the update! Can you possibly provide a pointer to that?

user2189998 Over a year ago

docs.github.com/en/actions/learn-github-actions/variables

Collectives™ on Stack Overflow

Read out environment name in github reusable workflow

2 Answers 2

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related