parent
9cd340508e
commit
c82c3a1b1d
14
README.md
14
README.md
|
@ -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`
|
||||||
|
@ -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:
|
||||||
|
|
|
@ -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'
|
||||||
|
|
|
@ -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`)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Reference in New Issue