CodeClimate

---

What is this action for?

This action allows you to automatically publish your packages to NPM.

How to use it?

You can use the following code as a new GitHub Actions Workflow:

name: {YOUR-ACTION-NAME}
on: [{YOUR-ACTION-EVENT}]
jobs:
  {YOUR-JOB-NAME}:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: {YOUR-STEP-NAME}
      uses: kaskadi/action-npmpub@master
      env:
        NODE_AUTH_TOKEN: {NODE_AUTH_TOKEN-VALUE}
        COMMIT_MSG: ${{ github.event.head_commit.message }}

Note: everything contained in single curly brackets ({ }) needs to be replaced by your desired values

Environment variables:

Variable	Required	Description
NODE_AUTH_TOKEN	true	NPM token which has read & publish permission. See here for details on how to generate a token. Recommend storing it in repository secrets!
COMMIT_MSG	true	Message of the commit that triggers the action. /!\ This should not be changed /!\

By default, this action will publish a new patch for your package. If you would like to publish a new major (resp. minor) version for this package, just prepend your commit message with *major* (resp. *minor*). This works as well with *patch* even though it's not required.

In order to sign the commit for your new package.json and package-lock.json files via GPG: add the following step before the actual publishing step:

    - name: Import GPG key
      uses: crazy-max/ghaction-import-gpg@v2
      with:
        git_user_signingkey: true
        git_commit_gpgsign: true
      env:
        GPG_PRIVATE_KEY: ${{ secrets.{YOUR-GPG-PRIVATE-KEY} }}
        PASSPHRASE: ${{ secrets.{YOUR-GPG-PRIVATE-KEY-PASSPHRASE} }}

If you do not need to sign your commit via GPG: simply replace the Import GPG key step of the job by:

    - name: Configure GitHub user
      run: |
        git config --global user.name $GH_USER_NAME
        git config --global user.email $GH_USER_EMAIL
      env:
        GH_USER_NAME: ${{ secrets.{YOUR-GITHUB-USER-NAME} }}
        GH_USER_EMAIL: ${{ secrets.{YOUR-GITHUB-USER-EMAIL} }}