Skip to content

feat: Migrate GitHub Actions from PAT to GitHub App authentication #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mbruzda-splunk wants to merge 4 commits into
base: develop
Choose a base branch
from
+61 −16
Draft

feat: Migrate GitHub Actions from PAT to GitHub App authentication #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26ccf6c
fix: update GS Docker image version
mbruzda-splunk Feb 11, 2026
ee2db4b
chore: update GitHub Actions workflows to use GitHub App authentication
mbruzda-splunk Apr 14, 2026
ef16165
chore: update GitHub Actions workflows to use secrets for GitHub App …
mbruzda-splunk Apr 14, 2026
d335c7e
Merge branch 'develop' into feat/gh_app_authentication
mbruzda-splunk Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/workflows/build-test-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,20 @@ jobs:
- pre-commit
runs-on: ubuntu-latest
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
with:
submodules: false
persist-credentials: false
- name: Semantic Release
uses: splunk/semantic-release-action@v1.3
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
with:
git_committer_name: ${{ secrets.SA_GH_USER_NAME }}
git_committer_email: ${{ secrets.SA_GH_USER_EMAIL }}
Expand All @@ -60,10 +66,16 @@ jobs:
needs: publish
runs-on: ubuntu-latest
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
- uses: splunk/addonfactory-update-semver@v1
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
with:
git_committer_name: ${{ secrets.SA_GH_USER_NAME }}
git_committer_email: ${{ secrets.SA_GH_USER_EMAIL }}
Expand Down
59 changes: 46 additions & 13 deletions .github/workflows/reusable-build-test-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,11 @@ on:
type: string
default: "0.3"
secrets:
GH_TOKEN_ADMIN:
description: Github admin token
GH_APP_CLIENT_ID:
description: GitHub App Client ID for authentication
required: true
GH_APP_PRIVATE_KEY:
description: GitHub App private key for authentication
required: true
SEMGREP_PUBLISH_TOKEN:
description: Semgrep token
Expand Down Expand Up @@ -518,6 +521,12 @@ jobs:
statuses: read
checks: write
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
Expand All @@ -534,8 +543,8 @@ jobs:
echo "No poetry.lock found, make sure your dependencies are managed through poetry, exiting"
exit 1
fi
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf ssh://git@github.com
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf ssh://git@github.com
python${{ env.PYTHON_VERSION }} -m venv ~/.dev_venv
~/.dev_venv/bin/python${{ env.PYTHON_VERSION }} -m pip install -r package/lib/requirements.txt
- name: Create directories
Expand Down Expand Up @@ -590,6 +599,12 @@ jobs:
contents: write
packages: read
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
with:
# Very Important semantic-release won't trigger a tagged
Expand All @@ -601,8 +616,8 @@ jobs:
python-version: ${{ env.PYTHON_VERSION }}
- name: create requirements file for pip
run: |
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf ssh://git@github.com
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf ssh://git@github.com
if [ -f "poetry.lock" ]
then
echo " poetry.lock found "
Expand Down Expand Up @@ -862,6 +877,12 @@ jobs:
if: ${{ !cancelled() && needs.build.result == 'success' && needs.setup-workflow.outputs.execute-gs-scorecard == 'true' }}
runs-on: ubuntu-latest
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
Expand All @@ -876,7 +897,7 @@ jobs:
docker pull 956110764581.dkr.ecr.us-west-2.amazonaws.com/ta-automation/gs-scorecard:${{ env.GS_IMAGE_VERSION }}
- name: Run GS Scorecard
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
GITHUB_USERNAME: ${{ secrets.SA_GH_USER_NAME }}
APPINSPECT_USER: ${{ secrets.SPL_COM_USER }}
APPINSPECT_PASS: ${{ secrets.SPL_COM_PASSWORD }}
Expand Down Expand Up @@ -938,10 +959,16 @@ jobs:
env:
BUILD_NAME: ${{ needs.build.outputs.buildname }}
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: actions/checkout@v4
with:
submodules: recursive
token: ${{ secrets.GH_TOKEN_ADMIN }}
token: ${{ steps.app-token.outputs.token }}
- name: setup for test
id: test-setup
shell: bash
Expand Down Expand Up @@ -993,9 +1020,9 @@ jobs:
python${{ env.PYTHON_VERSION }} -m pip install poetry==${{ env.POETRY_VERSION }}
export POETRY_REPOSITORIES_SPLUNK_ADD_ON_UCC_MODINPUT_TEST_URL=https://github.com/splunk/addonfactory-ucc-test.git
export POETRY_HTTP_BASIC_SPLUNK_ADD_ON_UCC_MODINPUT_TEST_USERNAME=${{ secrets.SA_GH_USER_NAME }}
export POETRY_HTTP_BASIC_SPLUNK_ADD_ON_UCC_MODINPUT_TEST_PASSWORD=${{ secrets.GH_TOKEN_ADMIN }}
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf ssh://git@github.com
export POETRY_HTTP_BASIC_SPLUNK_ADD_ON_UCC_MODINPUT_TEST_PASSWORD=${{ steps.app-token.outputs.token }}
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf https://github.com
git config --global --add url."https://${{ steps.app-token.outputs.token }}@github.com".insteadOf ssh://git@github.com
- name: modinput-test-prerequisites
if: steps.download-openapi.conclusion != 'skipped'
shell: bash
Expand Down Expand Up @@ -2969,6 +2996,12 @@ jobs:
pull-requests: read
statuses: write
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ secrets.GH_APP_CLIENT_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- name: Checkout
uses: actions/checkout@v4
with:
Expand All @@ -2979,7 +3012,7 @@ jobs:
id: semantic
uses: splunk/semantic-release-action@v1.3
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
with:
git_committer_name: ${{ secrets.SA_GH_USER_NAME }}
git_committer_email: ${{ secrets.SA_GH_USER_EMAIL }}
Expand All @@ -2990,7 +3023,7 @@ jobs:
id: custom
uses: "softprops/action-gh-release@v2"
with:
token: "${{ secrets.GH_TOKEN_ADMIN }}"
token: "${{ steps.app-token.outputs.token }}"
tag_name: v${{ github.event.inputs.custom-version }}
target_commitish: "${{github.ref_name}}"
make_latest: false
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ appinspect-api-html-report-self-service

- Verify that the required secrets are properly configured in GitHub Actions:
- `GSSA_AWS_ACCESS_KEY_ID` and `GSSA_AWS_SECRET_ACCESS_KEY` for AWS ECR access
- `GH_TOKEN_ADMIN` and `SA_GH_USER_NAME` for GitHub access
- `GH_APP_PRIVATE_KEY` (secret) and `GH_APP_CLIENT_ID` (variable) for GitHub App authentication, and `SA_GH_USER_NAME` for GitHub access
- `SPL_COM_USER` and `SPL_COM_PASSWORD` for AppInspect integration

- Check that the Docker image version specified via the `gs-image-version` workflow input (`GS_IMAGE_VERSION` env var, default `1.1`) exists in the ECR registry. The GS Scorecard tool version is controlled separately via `gs-version` input (`GS_VERSION` env var, default `0.3`).
Expand Down
Loading