https://github.com/gcarpenter-chain/wip-check

Action for blocking PRs on labels or titles indicating work in progress
https://github.com/gcarpenter-chain/wip-check

action typescript utility

Last synced: 19 days ago
JSON representation

Action for blocking PRs on labels or titles indicating work in progress

• Host: GitHub
• URL: https://github.com/gcarpenter-chain/wip-check
• Owner: gcarpenter-chain
• License: mit
• Created: 2020-03-09T17:29:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T09:32:36.000Z (almost 2 years ago)
• Last Synced: 2024-03-15T06:22:09.925Z (8 months ago)
• Topics: action, typescript, utility
• Language: TypeScript
• Homepage:
• Size: 2.05 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Setting up

Add the following yaml to your `.github/workflows` folder:

```yaml

name: WIP

on:

  pull_request:

    types: [ opened, synchronize, reopened, edited, labeled, unlabeled]

jobs:

  wip:

    runs-on: ubuntu-latest

    env:

      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    steps:

      - uses: gcarpenter-chain/wip-check@v1

```

You can specify custom labels patterns to block on (case insensitive) by passing in comma separated values to the `labels` input. By default it uses `wip,do not merge`.

```yaml

    steps:

      - uses: gcarpenter-chain/wip-check@v1

        with:

          # optional, case insensitive, defaults to: wip,do not merge

          labels: comma,separated,labels

```

## Structure

Based on , see there for more details

## Publish to a release branch

Run [ncc](https://github.com/zeit/ncc) and push the results:

```bash

$ npm run pack

$ git add dist

$ git commit -a -m "prod dependencies"

$ git push origin releases/v1

```

A new version is now published! :rocket:

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)