Merge pull request #130 from TriPSs/master

Release

README.md

@@ -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`
@@ -17,7 +17,7 @@ This action will bump version, tag commit and generate a changelog with conventi
 - **Optional** `version-path`: The place inside the version file to bump. Default `version`.
 - **Optional** `skip-on-empty`: Boolean to specify if you want to skip empty release (no-changelog generated). This case occured when you push `chore` commit with `angular` for example. Default `'true'`.
 - **Optional** `skip-version-file`: Do not update the version file. Default `'false'`.
-- **Optional** `skip-commit`: Do create a release commit. Default `'false'`.
+- **Optional** `skip-commit`: Do not create a release commit. Default `'false'`.
 - **Optional** `pre-commit`: Path to the pre-commit script file. No hook by default.
 - **Optional** `fallback-version`: The fallback version, if no older one can be detected, or if it is the first one. Default `'0.1.0'`
 - **Optional** `config-file-path`: Path to the conventional changelog config file. If set, the preset setting will be ignored
@@ -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:

action.yml

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

package-lock.json

@@ -2627,9 +2627,9 @@
       "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ=="
     },
     "y18n": {
-      "version": "4.0.0",
-      "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz",
-      "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==",
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.1.tgz",
+      "integrity": "sha512-wNcy4NvjMYL8gogWWYAO7ZFWFfHcbdbE57tZO8e4cbpj8tfUcwrwqSl3ad8HxpYWCdXcJUCeKKZS62Av1affwQ==",
       "dev": true
     },
     "yallist": {

src/helpers/git.js

@@ -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