feat: use same permissions used at repo checkout

closes #115
releases/v3
Carlos Meza 2021-09-27 23:08:04 -06:00
parent 9cd340508e
commit c82c3a1b1d
3 changed files with 21 additions and 7 deletions

View File

@ -4,7 +4,7 @@ This action will bump version, tag commit and generate a changelog with conventi
## Inputs
- **Required** `github-token`: Github token.
- **Optional** `github-token`: Github token, if different permissions required than from checkout.
- **Optional** `git-message`: Commit message that is used when committing the changelog.
- **Optional** `git-user-name`: The git user.name to use for the commit. Default `Conventional Changelog Action`
- **Optional** `git-user-email`: The git user.email to use for the commit. Default `conventional.changelog.action@github.com`
@ -188,6 +188,18 @@ Github releases
body: ${{ steps.changelog.outputs.clean_changelog }}
```
Use a deploy key
```yaml
- name: Checkout GitHub Action
uses: actions/checkout@v2
with:
ssh-key: ${{ secrets.SSH_DEPLOY_KEY }}
- name: Conventional Changelog Action
id: changelog
uses: TriPSs/conventional-changelog-action@v3
```
## Development
If you'd like to contribute to this project, all you need to do is clone and install [act](https://github.com/nektos/act) this project and run:

View File

@ -12,7 +12,7 @@ branding:
inputs:
github-token:
description: 'Github token'
required: true
required: false
git-message:
description: 'Commit message to use'

View File

@ -11,7 +11,7 @@ module.exports = new (class Git {
commandsRun = []
constructor() {
const githubToken = core.getInput('github-token', { required: true })
const githubToken = core.getInput('github-token')
// Make the Github token secret
core.setSecret(githubToken)
@ -37,8 +37,10 @@ module.exports = new (class Git {
this.config('user.email', gitUserEmail)
// Update the origin
if (githubToken) {
this.updateOrigin(`https://x-access-token:${githubToken}@github.com/${GITHUB_REPOSITORY}.git`)
}
}
/**
* Executes the git command