Skip to content
target

GitHub Action

Use NPM Token

v2.0.2 Latest version

Use NPM Token

target

Use NPM Token

Use an NPM token within an .npmrc file inside GitHub actions. Scoped packages are the primary use case

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Use NPM Token

              
  uses: dkershner6/use-npm-token-action@v2.0.2
Learn more about this action in dkershner6/use-npm-token-action

Choose a version

Use NPM Token GitHub Action

Use an NPM token within an .npmrc file inside GitHub actions. Scoped packages are the primary use case.

WARNING

If you commit after this action runs, you will likely leak your NPM token secret in your newly created .npmrc file. Please use GitIgnore Parser to fully prevent this from occurring.

Usage

Inputs

key default required description
token n/a true An NPM token with whatever access is needed for your GitHub Action workflow
workspace ./ false The location of your Node workspace (needs to be a sibling of package.json)

Outputs

None

Example Workflow

on: pull_request

jobs:
  test-coverage:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Use NPM Token with organization read access
        uses: dkershner6/use-npm-token-action@v2
        with:
          token: "${{ secrets.NPMJS_READ }}"
          workspace: ./node

      - run: npm i # This will now work with scoped packages

Contributing

All contributions are welcome, please open an issue or pull request.

To use this repository:

  1. npm i -g pnpm (if don't have pnpm installed)
  2. pnpm i
  3. npx projen (this will ensure everything is setup correctly, and you can run this command at any time)
  4. Good to make your changes!
  5. You can run npx projen build at any time to build the project.