Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/actions-cool/verify-files-modify

⚡ Verify PR files modification by GitHub Action.
https://github.com/actions-cool/verify-files-modify

actions files github-actions modify paths verify

Last synced: 2 months ago
JSON representation

⚡ Verify PR files modification by GitHub Action.

Host: GitHub
URL: https://github.com/actions-cool/verify-files-modify
Owner: actions-cool
License: mit
Created: 2021-02-18T12:55:36.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2022-09-08T12:39:37.000Z (over 2 years ago)
Last Synced: 2024-11-15T03:04:36.854Z (3 months ago)
Topics: actions, files, github-actions, modify, paths, verify
Language: JavaScript
Homepage:
Size: 232 KB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # ⚡ Verify Files Modify

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

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

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

Verify PR files modification.

Currently only `pull_request` and `pull_request_target` triggering is supported.

## How to use ?

```yml

name: Verify Files modify

on:

  pull_request_target:

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

jobs:

  verify:

    runs-on: ubuntu-latest

    steps:

      - name: verify-version

        uses: actions-cool/verify-files-modify@v1

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

          forbid-files: 'action.yml, LICENSE'

          forbid-paths: '.github/, dist/'

          assignees: 'xxx1, xxx2'

          comment: |

            Please don't modify this.

          close: true

```

| Name | Desc | Type | Required |

| -- | -- | -- | -- |

| token | GitHub token | string | ✖ |

| forbid-files | Forbid files. Higher than allowed. Support multiple | string | ✖ |

| forbid-paths | Forbid paths. Higher than allowed. Support multiple | string | ✖ |

| allowed-files | Allowed files. Support multiple | string | ✖ |

| allowed-paths | Allowed paths. Support multiple | string | ✖ |

| skip-verify-authority | Skip verify by creator authority. Option: `read` `write` `admin` | string | ✖ |

| skip-verify-users | Skip verify by creator userid. Support multiple | string | ✖ |

| skip-label | Skip label | string | ✖ |

| comment | Comment when verification success | string | ✖ |

| comment-mark | Comment mark to find. | string | ✖ |

| assignees | Assignees when verification success | string | ✖ |

| close | Close PR when verification success | boolean | ✖ |

| set-failed | When hit, whether set failed. Default true | boolean | ✖ |

## Note

- When PR come from fork, it requires `pull_request_target` to comment or close. When use pull_request_target, must [read](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)

- When use `pull_request` and PR come from fork. It will show CI badge status only

- `skip-verify-users`: like 'x1, x2, x3'

## ⚡ Feedback

You are very welcome to try it out and put forward your comments. You can use the following methods:

- Report bugs or consult with [Issue](https://github.com/actions-cool/verify-files-modify/issues)

- Submit [Pull Request](https://github.com/actions-cool/verify-files-modify/pulls) to improve the code of `verify-files-modify`

也欢迎加入 钉钉交流群

![](https://github.com/actions-cool/resources/blob/main/dingding.jpeg?raw=true)

## Changelog

[CHANGELOG](./CHANGELOG.md)

## LICENSE

[MIT](./LICENSE)