improve naming

Author: sg

.github/workflows/cdk-deploy.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Configure AWS Creds
         uses: aws-actions/configure-aws-credentials@v4
         with:
-          role-to-assume: "arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/GitHubActions"
+          role-to-assume: "arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/GithubActions"
           aws-region: ${{ secrets.AWS_REGION }}
 
       - name: Deploy CDK

README.md

@@ -1,6 +1,6 @@
 # AWS + Github Actions with OIDC
 
-This project is a TypeScript-based AWS CDK application that sets up an OpenID Connect (OIDC) provider for GitHub Actions, creates an IAM role for GitHub Actions to assume, and attaches necessary policies to the IAM role.
+This project is a TypeScript-based AWS CDK application that sets up an OpenID Connect (OIDC) provider for Github Actions, creates an IAM role for Github Actions to assume, and attaches necessary policies to the IAM role.
 
 ## Getting Started
 
@@ -41,7 +41,7 @@ npm test
 
 ## Deployment
 
-This project uses GitHub Actions for deployment. The workflow is defined in `.github/workflows/cdk-deploy.yml`. It is triggered manually, on push to the main branch, or on pull requests to the main branch.
+This project uses Github Actions for deployment. The workflow is defined in `.github/workflows/cdk-deploy.yml`. It is triggered manually, on push to the main branch, or on pull requests to the main branch.
 
 ## Built With
 

bin/gh-aws-deploy-oidc.ts bin/app.ts

@@ -8,15 +8,15 @@ import { GithubActionsPolicyStack } from '../lib/github-actions-policy-stack';
 const app = new App();
 
 // Create the OIDC provider stack
-// This stack sets up the OpenID Connect provider for GitHub Actions
+// This stack sets up the OpenID Connect provider for Github Actions
 const oidcGithubProviderStack = new GithubOidcProviderStack(app, 'GithubOidcProvider');
 
-// Create the GitHub Actions role stack
-// This stack creates an IAM role for GitHub Actions to assume
+// Create the Github Actions role stack
+// This stack creates an IAM role for Github Actions to assume
 // The role assumes the OIDC provider created in the previous stack
-const githubActionsRoleStack = new GithubActionsRoleStack(app, 'GithubActionsRole', oidcGithubProviderStack.oidcGithubProvider.openIdConnectProviderArn);
+const githubActionsRoleStack = new GithubActionsRoleStack(app, 'GithubActionsRole', oidcGithubProviderStack.GithubOIDCProvider.openIdConnectProviderArn);
 
-// Create the GitHub Actions policy stack
+// Create the Github Actions policy stack
 // This stack attaches necessary policies to the IAM role created in the previous stack
 new GithubActionsPolicyStack(app, 'GithubActionsPolicy', githubActionsRoleStack.role);
 

lib/github-actions-policy-stack.ts

@@ -49,7 +49,7 @@ export class GithubActionsPolicyStack extends cdk.Stack {
             sid: 'AllowCDKLambdaOperations'
         });
 
-        // Attach policies to the GitHub actions role
+        // Attach policies to the github actions role
         role.addToPolicy(cdkDeploymentPolicy);
         role.addToPolicy(ec2OperationsPolicy);
         role.addToPolicy(lambdaOperationsPolicy);

lib/github-actions-role-stack.ts

@@ -10,30 +10,30 @@ export class GithubActionsRoleStack extends cdk.Stack {
     constructor(scope: Construct, id: string, oidcProviderArn: string, props?: cdk.StackProps) {
         super(scope, id, props);
 
-        // Create a new IAM role for GitHub Actions to use
-        this.role = new Role(this, 'GitHubActionsRole', {
+        // Create a new IAM role for Github Actions to use
+        this.role = new Role(this, 'GithubActionsRole', {
             // Specify the principal that can assume this role
-            // Use the OIDC provider ARN for GitHub Actions
+            // Use the OIDC provider ARN for Github Actions
             assumedBy: new FederatedPrincipal(oidcProviderArn, {
                     StringEquals: {
                         // Conditions for the OIDC provider
                         'token.actions.githubusercontent.com:aud': 'sts.amazonaws.com',
                         'token.actions.githubusercontent.com:sub': [
-                            // Sets the Username/Organization, Repo, and GitHub environments that AWS will allow to be deployed from.
+                            // Sets the Username/Organization, Repo, and Github environments that AWS will allow to be deployed from.
                             // Only the specific repo and environment will be allowed, using temporary keys with OIDC.
                             // CASE SENSITIVE!
                             // 'repo:<USER/ORG_NAME>/<REPO>:environment:<GITHUB_ENV_NAME>'
                             'repo:sghost13/gh-aws-deploy-oidc:environment:dev'
                         ]
                     },
                 },
-                // The role action being assumed, allows a web identity(GitHub Runners) to assume the specified role.
+                // The role action being assumed, allows a web identity(Github Runners) to assume the specified role.
                 'sts:AssumeRoleWithWebIdentity'
             ),
             // Description for the role
             description: 'Role for Github Actions to deploy using CDK',
             // Custom name for the role
-            roleName: 'GitHubActions',
+            roleName: 'GithubActions',
             // Maximum duration for the role session
             maxSessionDuration: cdk.Duration.hours(1),
         });

lib/github-oidc-provider-stack.ts

@@ -5,16 +5,16 @@ import { OpenIdConnectProvider } from 'aws-cdk-lib/aws-iam';
 export class GithubOidcProviderStack extends cdk.Stack {
 
     // Declare a public readonly property for the OIDC provider
-    public readonly oidcGithubProvider: OpenIdConnectProvider;
+    public readonly GithubOIDCProvider: OpenIdConnectProvider;
 
     constructor(scope: Construct, id: string, props?: cdk.StackProps) {
         super(scope, id, props);
 
         // Create a new OpenIdConnectProvider
-        // This OIDC provider allows GitHub Actions Runners to interact with AWS services
+        // This OIDC provider allows Github Actions Runners to interact with AWS services
         // Set when and how the interaction takes place in the policy/role
-        this.oidcGithubProvider = new OpenIdConnectProvider(this, 'GithubOIDCProvider', {
-            // The URL of the OIDC identity provider, in this case GitHub
+        this.GithubOIDCProvider = new OpenIdConnectProvider(this, 'GithubOIDCProvider', {
+            // The URL of the OIDC identity provider, in this case Github
             url: 'https://token.actions.githubusercontent.com',
             // The client IDs that are allowed to authenticate using this OIDC provide, in this case aws sts service
             clientIds: ['sts.amazonaws.com']