https://github.com/technote-space/can-npm-publish-action

GitHub Actions to check if it can be published to npm.
https://github.com/technote-space/can-npm-publish-action

github-actions npm

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/technote-space/can-npm-publish-action
• Owner: technote-space
• License: mit
• Created: 2020-03-06T09:44:45.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-02-16T15:07:18.000Z (over 2 years ago)
• Last Synced: 2025-03-08T20:04:38.416Z (4 months ago)
• Topics: github-actions, npm
• Language: TypeScript
• Homepage:
• Size: 8.09 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.ja.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Can npm publish action

[![CI Status](https://github.com/technote-space/can-npm-publish-action/workflows/CI/badge.svg)](https://github.com/technote-space/can-npm-publish-action/actions)

[![codecov](https://codecov.io/gh/technote-space/can-npm-publish-action/branch/main/graph/badge.svg)](https://codecov.io/gh/technote-space/can-npm-publish-action)

[![CodeFactor](https://www.codefactor.io/repository/github/technote-space/can-npm-publish-action/badge)](https://www.codefactor.io/repository/github/technote-space/can-npm-publish-action)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/can-npm-publish-action/blob/main/LICENSE)

*Read this in other languages: [English](README.md), [日本語](README.ja.md).*

npm に公開可能かチェックする`GitHub Actions`です。  

このアクションは [can-npm-publish](https://github.com/azu/can-npm-publish) を使用します。

## Table of Contents

Details

- [使用方法](#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)

- [スクリーンショット](#%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88)

  - [Passed](#passed)

  - [Failed](#failed)

- [オプション](#%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3)

- [Outputs](#outputs)

- [Action イベント詳細](#action-%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E8%A9%B3%E7%B4%B0)

  - [対象イベント](#%E5%AF%BE%E8%B1%A1%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88)

- [Author](#author)

## 使用方法

例：`.github/workflows/check-publish.yml`

```yaml

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

```

## スクリーンショット

### Passed

![Checks](https://raw.githubusercontent.com/technote-space/can-npm-publish-action/images/screenshot-1.png)

### Failed

![Error1](https://raw.githubusercontent.com/technote-space/can-npm-publish-action/images/screenshot-2.png)

![Error2](https://raw.githubusercontent.com/technote-space/can-npm-publish-action/images/screenshot-3.png)

## オプション

| name | description | default | required | e.g. |

|:---:|:---|:---:|:---:|:---:|

| PACKAGE_PATH | ディレクトリ または package.json へのパス | | | `assets/package.json` |

| VERBOSE | エラーの詳細を表示するかどうか | `true` | | `false` |

| GITHUB_TOKEN | アクセストークン | `${{github.token}}` | true | `${{secrets.ACCESS_TOKEN}}` |

## Outputs

| name | description | e.g. |

|:---:|:---|:---:|

| result | action result (passed or failed) | `passed` |

## Action イベント詳細

### 対象イベント

| eventName | action |

|:---:|:---:|

|pull_request, pull_request_target|opened, reopened, synchronize|

## Author

[GitHub (Technote)](https://github.com/technote-space)  

[Blog](https://technote.space)