Skip to content

feat: github pat for authenticated install kustomize requests#103

Open
bnormington wants to merge 1 commit into
mainfrom
feat/authenticated-github-requests
Open

feat: github pat for authenticated install kustomize requests#103
bnormington wants to merge 1 commit into
mainfrom
feat/authenticated-github-requests

Conversation

@bnormington

@bnormington bnormington commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

SUMMARY

This adds optional GitHub PAT authentication when the orb downloads install_kustomize.sh during the deploy-with-kustomize command and job.

A new github-pat-env parameter (default GITHUB_PAT) lets you point at a CircleCI environment variable that holds a GitHub personal access token. When that variable is set, the install script is fetched with an Authorization: Bearer header; when it is unset or empty, behavior stays the same as before with an unauthenticated download.

This helps avoid GitHub rate limits and download failures when pulling from raw.githubusercontent.com in CI, without requiring every project to configure a PAT. Unauthenticated API requests are capped at 60 per hour, while authenticated requests grant you up to 5,000 requests per hour.

In CircleCI a new github-goodway-bot-public-readonly goodway context was added to hold the goodway-bot's public and readonly Personal Access Token. This token has no permissions. To configure update orb version and add the github-goodway-bot-public-readonly to the context list

      - goodway/deploy-with-kustomize:
          name: deploy-staging
          context:
            - aws-oidc
            - aws-ecr
            - slack-notifications
            - github-goodway-bot-public-readonly

You can also change the env var name if you want to build upon other settings.

     - goodway/deploy-with-kustomize:
          name: deploy-staging
          github-pat-env: GITHUB_PERSONAL_ACCESS_TOKEN
          context:
            - aws-oidc
            - aws-ecr
            - slack-notifications

TESTING

See CircleCI Job for authenticated request

2026-07-05_12-10-08

See CircleCI Job for unauthenticated request

2026-07-05_12-10-41

@bnormington bnormington added the feature New feature or request label Jul 5, 2026
@bnormington bnormington self-assigned this Jul 5, 2026
@bnormington bnormington added the feature New feature or request label Jul 5, 2026
@bnormington
bnormington requested review from a team, mattfraz and rartemov July 5, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or request

Development

Successfully merging this pull request may close these issues.

1 participant