/can-npm-publish-action

GitHub Actions to check if it can be published to npm.

Primary LanguageTypeScriptMIT LicenseMIT

Can npm publish action

CI Status codecov CodeFactor License: MIT

Read this in other languages: English, 日本語.

GitHub Actions to check if it can be published to npm.
This action uses can-npm-publish.

Table of Contents

Details

Usage

e.g. .github/workflows/check-publish.yml

on: pull_request

name: Check npm publish

jobs:
  checkPublish:
    name: Check npm publish
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: technote-space/can-npm-publish-action@v1

Screenshots

Passed

Checks

Failed

Error1

Error2

Options

name description default required e.g.
PACKAGE_PATH Directory or package.json path assets/package.json
VERBOSE Whether to show detail of errors true false
GITHUB_TOKEN Access token ${{github.token}} true ${{secrets.ACCESS_TOKEN}}

Outputs

name description e.g.
result action result (passed or failed) passed

Action event details

Target events

eventName action
pull_request, pull_request_target opened, reopened, synchronize

Author

GitHub (Technote)
Blog