https://github.com/dkershner6/use-npm-token-action

Use an NPM token within an .npmrc file inside GitHub actions. Scoped packages are the primary use case.
https://github.com/dkershner6/use-npm-token-action

github-actions nodejs

Last synced: 29 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dkershner6/use-npm-token-action
• Owner: dkershner6
• License: apache-2.0
• Created: 2020-07-30T16:45:08.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T00:03:50.000Z (7 months ago)
• Last Synced: 2024-04-14T00:24:39.760Z (7 months ago)
• Topics: github-actions, nodejs
• Language: TypeScript
• Homepage:
• Size: 914 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/marketplace/actions/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

```yaml

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.