Skip to content

Commit

Permalink
docs: add section about commit signing using GitHub App (#838)
Browse files Browse the repository at this point in the history
  • Loading branch information
etiennetremel committed May 13, 2024
1 parent fb25c83 commit 6537be5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,22 @@ jobs:
token: '${{ steps.get_token.outputs.token }}'
```

### Commit signing with GitHub App

Renovate can sign commits when deployed as a GitHub App by utilizing GitHub's API-based commits.
To activate this, ensure that `platformCommit` is set to `true` in global config.
If a configuration file is defined, include `platformCommit: true` to activate this feature.
For example:

```yaml
- name: Self-hosted Renovate
uses: renovatebot/github-action@v40.1.11
with:
token: '${{ steps.get_token.outputs.token }}'
env:
RENOVATE_PLATFORM_COMMIT: 'true'
```

## Environment Variables

If you wish to pass through environment variables through to the Docker container that powers this action you need to prefix the environment variable with `RENOVATE_`.
Expand Down

0 comments on commit 6537be5

Please sign in to comment.