Add gitcommitid to stack output - #227
Merged
Merged
Conversation
alexiswl
force-pushed
the
feature/add-git-commit-id-to-stack
branch
from
June 4, 2026 09:17
9fa0b51 to
ee3aa9b
Compare
alexiswl
marked this pull request as ready for review
June 4, 2026 09:20
Contributor
There was a problem hiding this comment.
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) andaddGitCommitIdOutput()utilities inpackages/utils. - Introduced a
GitStackclass extendingcdk.Stackand 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.