[@aws-cdk/pipelines] - Can't get the Commit SHA

When using GitHubSourceAction we should be able to get the “sha” of the commit that triggered the action. The TypeScript shows that it should be available under variables.commitId.

However, in my pipeline, it’s just giving me a template variable (or something like that): #{Source_GitHub_NS.CommitId}

Reproduction Steps

The code looks like this:

const sourceAction = new cpa.GitHubSourceAction({
      actionName: "GitHub",
      output: sourceArtifact,
      oauthToken: cdk.SecretValue.secretsManager("github-repo-token"),
      owner: "github-username",
      repo: "the-repo",
      branch: "dev",
    })

    const sha = sourceAction.variables.commitId // returns #{Source_GitHub_NS.CommitId}

How can we get the actual SHA in this scenario?

---

This is 🐛 Bug Report

[skinny85]

Hey @arpowers ,

thanks for opening the issue. The commit is only available during Pipeline execution, as it changes each time you push something to your repository. That’s why it’s available as this #{Source_GitHub_NS.CommitId} expression. You can pass it to a different thing in your pipeline - for example, the environment variables of your CodeBuild Project:

new CodeBuildAction({
  // ...
  environmentVariables: {
    COMMIT_ID: { value: sourceAction.variables.commitId },
  },
});

And then read the COMMIT_ID environment variable when executing the build.

Hope this clears this up!

Thanks, Adam

[github-actions[bot]]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.