Skip to content

Add gitcommitid to stack output - #227

Merged
alexiswl merged 7 commits into
mainfrom
feature/add-git-commit-id-to-stack
Jun 10, 2026
Merged

Add gitcommitid to stack output#227
alexiswl merged 7 commits into
mainfrom
feature/add-git-commit-id-to-stack

Conversation

@alexiswl

@alexiswl alexiswl commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

@alexiswl alexiswl self-assigned this Apr 8, 2026
@alexiswl alexiswl added the enhancement New feature or request label Apr 8, 2026
@alexiswl
alexiswl force-pushed the feature/add-git-commit-id-to-stack branch from 9fa0b51 to ee3aa9b Compare June 4, 2026 09:17
@alexiswl
alexiswl marked this pull request as ready for review June 4, 2026 09:20
Copilot AI review requested due to automatic review settings June 4, 2026 09:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a mechanism to expose the current Git commit identifier in synthesized/deployed CDK stacks (for traceability), and updates generated TypeDoc documentation to reflect the new utilities and GitStack class.

Changes:

  • Added resolveGitCommitId() (CodeBuild-aware) and addGitCommitIdOutput() utilities in packages/utils.
  • Introduced a GitStack class extending cdk.Stack and exporting it from the deployment pipeline package.
  • Regenerated/updated documentation entries and line references for the affected namespaces.

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
packages/utils/index.ts Adds git SHA resolution + stack output helper (contains a breaking CfnOutput prop issue to fix).
packages/docs/@orcabus/namespaces/utils/README.md Adds links for newly documented utils functions.
packages/docs/@orcabus/namespaces/utils/functions/synthesisMessageToString.md Updates “Defined in” line reference after code shift.
packages/docs/@orcabus/namespaces/utils/functions/resolveStageName.md Updates “Defined in” line reference after code shift.
packages/docs/@orcabus/namespaces/utils/functions/resolveGitCommitId.md New generated docs page for resolveGitCommitId.
packages/docs/@orcabus/namespaces/utils/functions/addGitCommitIdOutput.md New generated docs page for addGitCommitIdOutput.
packages/docs/@orcabus/namespaces/deploymentPipeline/variables/DEFAULT_PARTIAL_BUILD_SPEC.md Updates “Defined in” line reference after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/variables/DEFAULT_INSTALL_COMMANDS.md Updates “Defined in” line reference after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/README.md Adds GitStack to the documented class list.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/StageEnvProps.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/StackConfigProps.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/FailOnDriftBuildStepProps.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/DriftCheckConfig.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/DeploymentStackPipelineProps.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/CodeBuildStepProps.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/interfaces/CacheOptions.md Updates “Defined in” line references after code shift.
packages/docs/@orcabus/namespaces/deploymentPipeline/classes/GitStack.md New generated docs page for GitStack.
packages/docs/@orcabus/namespaces/deploymentPipeline/classes/DeploymentStackPipeline.md Updates “Defined in” line references after code shift.
packages/deployment-stack-pipeline/stack.ts Adds GitStack class that injects the GitCommitId output.
packages/deployment-stack-pipeline/pipeline.ts Adds (currently unused) import for resolveGitCommitId.
packages/deployment-stack-pipeline/index.ts Exports the new stack module.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/utils/index.ts
Comment thread packages/utils/index.ts
Comment thread packages/deployment-stack-pipeline/stack.ts Outdated
Comment thread packages/deployment-stack-pipeline/pipeline.ts Outdated
alexiswl and others added 2 commits June 5, 2026 08:49
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@alexiswl
alexiswl added this pull request to the merge queue Jun 10, 2026
Merged via the queue into main with commit 52c171d Jun 10, 2026
5 checks passed
@alexiswl
alexiswl deleted the feature/add-git-commit-id-to-stack branch June 10, 2026 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants