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 ## 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-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-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` - **Optional** `git-user-email`: The git user.email to use for the commit. Default `conventional.changelog.action@github.com`
@ -56,9 +56,9 @@ A bunch of useful environment variables are available to the script with `proces
### Pre-Changelog-Generation hook ### Pre-Changelog-Generation hook
> Function in a specified file will be run right before the changelog generation phase, when the next > Function in a specified file will be run right before the changelog generation phase, when the next
> version is already known, but it was not used anywhere yet. It can be useful if you want to manually update version or tag. > version is already known, but it was not used anywhere yet. It can be useful if you want to manually update version or tag.
Same restrictions as for the pre-commit hook, but exported functions names should be `preVersionGeneration` for modifications to the version and `preTagGeneration` for modifications to the git tag. Same restrictions as for the pre-commit hook, but exported functions names should be `preVersionGeneration` for modifications to the version and `preTagGeneration` for modifications to the git tag.
Following props will be passed to the function as a single parameter and same output is expected: Following props will be passed to the function as a single parameter and same output is expected:
@ -73,7 +73,7 @@ export function preTagGeneration(tag: string): string {}
### Config-File-Path ### Config-File-Path
A config file to define the conventional commit settings. Use it if you need to override values like `issuePrefix` or `issueUrlFormat`. If you set a `config-file-path`, the `preset` setting will be ignored. Therefore use an existing config and override the values you want to adjust. A config file to define the conventional commit settings. Use it if you need to override values like `issuePrefix` or `issueUrlFormat`. If you set a `config-file-path`, the `preset` setting will be ignored. Therefore use an existing config and override the values you want to adjust.
example: example:
```javascript ```javascript
'use strict' 'use strict'
const config = require('conventional-changelog-conventionalcommits'); const config = require('conventional-changelog-conventionalcommits');
@ -188,6 +188,18 @@ Github releases
body: ${{ steps.changelog.outputs.clean_changelog }} 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 ## 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: 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: inputs:
github-token: github-token:
description: 'Github token' description: 'Github token'
required: true required: false
git-message: git-message:
description: 'Commit message to use' description: 'Commit message to use'

View File

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