https://github.com/actions-cool/verify-package-version

🙏 A GitHub Action that verify your package version whether meets some conditions.
https://github.com/actions-cool/verify-package-version

actions github-actions package verify version

Last synced: 4 months ago
JSON representation

🙏 A GitHub Action that verify your package version whether meets some conditions.

• Host: GitHub
• URL: https://github.com/actions-cool/verify-package-version
• Owner: actions-cool
• License: mit
• Created: 2021-02-03T05:03:50.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-10-18T06:11:06.000Z (over 4 years ago)
• Last Synced: 2026-01-18T12:27:26.055Z (5 months ago)
• Topics: actions, github-actions, package, verify, version
• Language: JavaScript
• Homepage:
• Size: 138 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🙏 Verify Package Version

![](https://img.shields.io/github/workflow/status/actions-cool/verify-package-version/CI?style=flat-square)

[![](https://img.shields.io/badge/marketplace-verify--package--version-blueviolet?style=flat-square)](https://github.com/marketplace/actions/verify-package-version)

[![](https://img.shields.io/github/v/release/actions-cool/verify-package-version?style=flat-square&color=orange)](https://github.com/actions-cool/verify-package-version/releases)

Verify your package version whether meets some conditions.

Currently only PR triggering is supported, and more scenario requirements can be raised through [issue](https://github.com/actions-cool/verify-package-version/issues).

## Preview

- [#6](https://github.com/actions-cool/verify-package-version/pull/6)

![](./public/2.png)

![](./public/1.png)

## How to use ?

```yml

name: Verify Package Version

on:

  pull_request:

    types: [opened, edited, reopened, synchronize, ready_for_review]

jobs:

  verify:

    runs-on: ubuntu-latest

    # Add conditions to trigger more effectively

    if: contains(github.event.pull_request.title, 'changelog')

    steps:

      - uses: actions/checkout@v2

      - name: verify-version

        uses: actions-cool/verify-package-version@v1

        with:

          title-include-content: 'docs'

          title-include-version: true

          open-comment: true

```

- `title-include-content`: Verify that the title contains content

- `title-include-version`: Verify that the title whether contains version, default `true`

- `open-comment`：Whether to open comments, default `false`

## Note

- When set `open-comment`, the ref of PR must be in the current repositorie

- When use `1.1.0+` and PR ref is base branch, it will use `fs.readFileSync`. This requires you add `- uses: actions/checkout@v2`

## Changelog

[CHANGELOG](./CHANGELOG.md)

## LICENSE

[MIT](https://github.com/actions-cool/verify-package-version/blob/main/LICENSE)