Install the scriv-release App
This page registers a private GitHub App in your account or
organization with the permissions required by the
scriv-release action: contents: write and
pull_requests: write. The App is owned by you;
scriv-release never sees its private key.
You can change the suggested name (scriv-release-bot) on
the next page if it's already taken — GitHub App names are
globally unique.
Manual setup (or to inspect the manifest)
If you'd rather create the App by hand, navigate to https://github.com/settings/apps/new (or your org's equivalent) and fill in:
- Repository permissions:
Contents: Read and write -
Repository permissions:
Pull requests: Read and write - Subscribe to events: none
The manifest used by the buttons above:
App created — next steps
GitHub returned you here after creating the App. The App now exists in your account or organization, but it isn't wired to your repo yet.
-
Open the App's settings page from
your apps (personal)
or
Settings → Developer settings → GitHub Apps(organization). Note its App ID — you'll need it. -
Scroll to Private keys and click
Generate a private key. A
.pemfile downloads — keep it; you'll paste its contents into a repo secret. -
Click Install App in the sidebar and install it on
the repo (or repos) you want
scriv-releaseto manage. -
In the repo:
Settings → Secrets and variables → Actions:-
Add a variable (e.g.
RELEASE_APP_ID) set to the App ID from step 1. -
Add a secret (e.g.
RELEASE_APP_KEY) set to the full contents of the.pemfile.
-
Add a variable (e.g.
-
Reference them in your release workflow:
- uses: whitphx/scriv-release@v0.3.0 with: app-id: ${{ vars.RELEASE_APP_ID }} app-private-key: ${{ secrets.RELEASE_APP_KEY }}
See
docs/token-setup.md
for context on why a GitHub App is recommended over the default
GITHUB_TOKEN.