Skip to content

Latest commit

 

History

History
 
 

GitHub-Git-Tag

README.md

GitHub::Git::Tag

This resource type manages a GitHub Git Tag

Documentation

Prerequisites

AWS Management Console

To get started:

  1. Sign in to the AWS Management Console with your account and navigate to CloudFormation.

  2. Select "Public extensions" from the left hand pane and filter Publisher by "Third Party".

  3. Use the search bar to filter by the "GitHub" prefix.

Note: All official GitHub resources begin with GitHub:: and specify that they are Published by GitHub.

  1. Select the desired resource name to view more information about its schema, and click Activate.

  2. On the Extension details page, specify:

  • Extension name
  • Execution role ARN
  • Automatic updates for minor version releases
  • Configuration
  1. In your terminal, specify the configuration data for the registered GitHub CloudFormation resource type, in the given account and region by using the SetTypeConfiguration operation:

For example:

$ aws cloudformation set-type-configuration \
--region us-west-2 --type RESOURCE \
--type-name GitHub::Git::Tag \
--configuration-alias default \
--configuration '{"GitHubAccess": {"AccessToken": "{{resolve:ssm-secure:/cfn/github/accesstoken:1}}"}}'
  1. After you have your resource configured, create your AWS stack that includes any of the activated GitHub resources.

For more information about available commands and workflows, see the official AWS documentation.

Supported regions

The GitHub CloudFormation resources are available on the CloudFormation Public Registry in the following regions:

Code Name
us-east-1 US East (N. Virginia)
us-east-2 US East (Ohio)
us-west-1 US West (N. California)
us-west-2 US West (Oregon)
ap-south-1 Asia Pacific (Mumbai)
ap-northeast-1 Asia Pacific (Tokyo)
ap-northeast-2 Asia Pacific (Seoul)
ap-southeast-1 Asia Pacific (Singapore)
ap-southeast-2 Asia Pacific (Sydney)
ca-central-1 Canada (Central)
eu-central-1 Europe (Frankfurt)
eu-west-1 Europe (Ireland)
eu-west-2 Europe (London)
eu-west-3 Europe (Paris)
eu-north-1 Europe (Stockholm)
sa-east-1 South America (São Paulo)

Note: To privately register a resource in any other region, use the provided packages.

Examples

Add a tag to a repository in GitHub

---
AWSTemplateFormatVersion: '2010-09-09'
Description: Add a tag to a repository
Resources:
  Tag:
    Type: GitHub::Git::Tag
    Properties:
      Owner: ACME-CloudFormation
      Repository: !Ref RepoName
      Tag: Latest
      Sha: 6907b5086cfdc46381af05d94c2e41ac6812a962
      Force: false