layerborncdkgittagger

README

CDK Aspect Git Tagger

This is a CDK Aspect that will tag your CDK Stacks with the current git repo location for easier identification of deployed stacks.

How to install

npm install @layerborn/cdk-git-tagger

or

npm install @layerborn/cdk-git-tagger

How to use

import { GitUrlTagger } from '@layerborn/cdk-git-tagger';
import { App, Aspects, Stack, StackProps } from 'aws-cdk-lib';
import { Topic } from 'aws-cdk-lib/aws-sns';
import { Construct } from 'constructs';

export class MyStack extends Stack {
    constructor(scope: Construct, id: string, props: StackProps = {}) {
        super(scope, id, props);
        // define resources here...
        new Topic(this, 'MyTopic');
    }
}

const app = new App();

new MyStack(app, 'cdk-aspect-git-tagger-tester');
Aspects.of(app).add(new GitUrlTagger());
app.synth();

Example Output

{
  "Resources": {
    "MyTopic86869434": {
      "Type": "AWS::SNS::Topic",
      "Properties": {
        "Tags": [
          {
            "Key": "GitUrl",
            "Value": "https://github.com/layerborn/cdk-cool-construct.git"
          }
        ]
      }
    }
  }
}

Documentation

Overview

CDK Aspect to tag resources with git metadata. This provides a nice connection between the construct and the git repository.

Index

• func NewGitUrlTagger_Override(g GitUrlTagger, props *GitUrlTaggerProps)
• type GitUrlTagger
  • func NewGitUrlTagger(props *GitUrlTaggerProps) GitUrlTagger
• type GitUrlTaggerProps

Functions

func NewGitUrlTagger_Override

func NewGitUrlTagger_Override(g GitUrlTagger, props *GitUrlTaggerProps)

Types

type GitUrlTagger

type GitUrlTagger interface {
	awscdk.IAspect
	FindGitDirectory() *string
	PutGitUrlInFile(gitUrl *string)
	RetrieveGitUrl() *string
	// All aspects can visit an IConstruct.
	Visit(construct constructs.IConstruct)
}

func NewGitUrlTagger

func NewGitUrlTagger(props *GitUrlTaggerProps) GitUrlTagger

type GitUrlTaggerProps

type GitUrlTaggerProps struct {
	// A flag on whether to try to normalize the URL found in the git config If enabled, it will turn ssh urls into https urls.
	// Default: true.
	//
	NormalizeUrl *bool `field:"optional" json:"normalizeUrl" yaml:"normalizeUrl"`
	// The Tag key/name to use.
	// Default: 'GitUrl'.
	//
	TagName *string `field:"optional" json:"tagName" yaml:"tagName"`
}