@cloudcomponents/cdk-pull-request-approval-rule

CodeCommit pull request approval rules to enforcing your pull request workflow

Install

TypeScript/JavaScript:

npm i @cloudcomponents/cdk-pull-request-approval-rule

Python:

pip install cloudcomponents.cdk-pull-request-approval-rule

How to use

import { ApprovalRuleTemplate, ApprovalRuleTemplateRepositoryAssociation } from '@cloudcomponents/cdk-pull-request-approval-rule';
import { PullRequestCheck } from '@cloudcomponents/cdk-pull-request-check';
import { Stack, StackProps } from 'aws-cdk-lib';
import { BuildSpec } from 'aws-cdk-lib/aws-codebuild';
import { Repository } from 'aws-cdk-lib/aws-codecommit';
import { Construct } from 'constructs';

export class PullRequestStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const repository = new Repository(this, 'Repository', {
      repositoryName: 'pr-check-repository',
    });

    const { approvalRuleTemplateName } = new ApprovalRuleTemplate(this, 'ApprovalRuleTemplate', {
      approvalRuleTemplateName: 'template-name',
      template: {
        approvers: {
          numberOfApprovalsNeeded: 1,
        },
      },
    });

    new ApprovalRuleTemplateRepositoryAssociation(this, 'ApprovalRuleTemplateRepositoryAssociation', {
      approvalRuleTemplateName,
      repository,
    });

    new PullRequestCheck(this, 'PullRequestCheck', {
      repository,
      buildSpec: BuildSpec.fromSourceFilename('prcheck.yml'),
    });
  }
}

ApprovalRuleOverridden notification

import { ApprovalRuleTemplate, ApprovalRuleTemplateRepositoryAssociation } from '@cloudcomponents/cdk-pull-request-approval-rule';
import { PullRequestCheck } from '@cloudcomponents/cdk-pull-request-check';
import { Stack, StackProps } from 'aws-cdk-lib';
import { BuildSpec } from 'aws-cdk-lib/aws-codebuild';
import { Repository } from 'aws-cdk-lib/aws-codecommit';
import { SnsTopic } from 'aws-cdk-lib/aws-events-targets';
import { Topic } from 'aws-cdk-lib/aws-sns';
import { Construct } from 'constructs';

export class PullRequestStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const repository = new Repository(this, 'Repository', {
      repositoryName: 'pr-check-repository',
    });

    const { approvalRuleTemplateName } = new ApprovalRuleTemplate(
      this,
      'ApprovalRuleTemplate',
      {
        approvalRuleTemplateName: 'template-name',
        template: {
          approvers: {
            numberOfApprovalsNeeded: 1,
          },
        },
      },
    );

    const ruleAsscociation = new ApprovalRuleTemplateRepositoryAssociation(
      stack,
      'ApprovalRuleTemplateRepositoryAssociation',
      {
          approvalRuleTemplateName,
          repository,
      },
    );

    const topic = new Topic(stack, 'Topic');

    ruleAsscociation.onOverridden('overridden', {
        target: new SnsTopic(topic),
    });

    // Approves the pull request
    new PullRequestCheck(this, 'PullRequestCheck', {
        repository,
        buildSpec: BuildSpec.fromSourceFilename('prcheck.yml'),
    });
  }
}

API Reference

See API.md.

Example

See more complete examples.

License

MIT

Metadata

Release files for cloudcomponents.cdk-pull-request-approval-rule 2.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cloudcomponents.cdk-pull-request-approval-rule 2.4.0
File	Size	Uploaded
cloudcomponents.cdk-pull-request-approval-rule-2.4.0.tar.gz	142.4 kB	May 16, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for cloudcomponents.cdk-pull-request-approval-rule 2.4.0
File	Interpreter	ABI	Platform	Reset
cloudcomponents.cdk_pull_request_approval_rule-2.4.0-py3-none-any.whl 141.4 kB May 16, 2024	Python 3	none	any	Details

Total release size: 283.8 kB

Release files / cloudcomponents.cdk-pull-request-approval-rule-2.4.0.tar.gz

Download URL	cloudcomponents.cdk-pull-request-approval-rule-2.4.0.tar.gz
Size	142.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`fff9b374fa8a1a95e605eff7d83189a641e0b35d563018dbf0c947ba24e70bdd`
BLAKE2b-256 checksum How to use checksums	`387f7287fc1db032b911f15203b6e03affad5a3333b7dc48c3be2f25904bad42`
Upload date	May 16, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`

Release files / cloudcomponents.cdk_pull_request_approval_rule-2.4.0-py3-none-any.whl

Download URL	cloudcomponents.cdk_pull_request_approval_rule-2.4.0-py3-none-any.whl
Size	141.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7c485ef804c8761696d234fc574b9e89bd02e6c60c6eb6df61b6f13b9a838c7f`
BLAKE2b-256 checksum How to use checksums	`2f4d6db02015837cc45c917df638e3e6c859f81d1a4f5dbfb21c316d8922054f`
Upload date	May 16, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`