https://github.com/20minutes/serverless-github-check
:zap: A Serverless project to validate GitHub PRs against some specifications
https://github.com/20minutes/serverless-github-check
20minutes github github-webhooks noservernovember serverless serverless-framework
Last synced: 7 months ago
JSON representation
:zap: A Serverless project to validate GitHub PRs against some specifications
- Host: GitHub
- URL: https://github.com/20minutes/serverless-github-check
- Owner: 20minutes
- License: mit
- Created: 2018-11-12T14:12:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T00:43:28.000Z (8 months ago)
- Last Synced: 2024-10-24T04:44:56.895Z (8 months ago)
- Topics: 20minutes, github, github-webhooks, noservernovember, serverless, serverless-framework
- Language: JavaScript
- Homepage:
- Size: 7.01 MB
- Stars: 13
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless GitHub Check
[](https://serverless.com/)
[](https://github.com/20minutes/serverless-github-check/actions/workflows/tests.yml)
Apply some simple checks on each PR.
## Use Cases
We have 4 functions available:
- **specification**: It validates GitHub Pull Requests against some specifications:
- `body` should be at least 8 characters long
- `title` should be at least 8 characters long
- **label**: It checks if there is a blocking label in the GitHub Pull Request
- if one blocking label (default: `Work In Progress`, `Waiting For Change`, `Waiting For Travis`) is found, PR is blocked
- if no labels are defined in the PR, PR is blocked
- if no blocking labels are defined, PR is validated
- **fixup**: It checks if there is some `fixup!` commits in the PR history
- if at least one fixup commit are found, PR is blocked
- if no fixup commits are found, PR is validated
- **autoMerge**: It merges PR from @dependabot when the update it for a patch or a minor version
- the repo must have the _auto merge_ option enabled
## Prerequisites
- Node.js 20
- Serverless CLI v3 (`npm install -g serverless@3`)
- An AWS account
- Defined [provider credentials](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
## Setup
### Deploy the code
- Get a [new personal access token](https://github.com/settings/tokens/new) on GitHub
- Set it in [AWS Parameter Store](https://eu-west-1.console.aws.amazon.com/systems-manager/parameters/create?region=eu-west-1) as a `SecureString` with name `GITHUB_TOKEN`
- Deploy the service using: `serverless deploy`
By default
- it'll use the AWS profile `default`, but you can use your own using (be sure it's defined in your `~/.aws/credentials`): `serverless deploy --aws-profile myprofile`
- it'll be deployed to the AWS region `eu-west-1` but you can change it using: `serverless deploy --region us-east-1`
### Setup GitHub webhook
Configure the webhook in [the GitHub repository settings](https://developer.github.com/webhooks/creating/#setting-up-a-webhook).
- In the Payload URL, enter the URL you received after deploying. It would be something like `https://.amazonaws.com/dev/webhook`.
- Choose the "application/json" in Content type.
- In the types of events to trigger the webhook, select "Let me select individual events", then select at least `Pull Requests`.
### Some options
You can update some options from the `serverless.yml` file:
- `NAMESPACE`: change the namespace used in the PR check (displayed at the bottom of each PR)
- `CHECK_BODY_LENGTH`: change the minimun length of the body of the PR
- `CHECK_TITLE_LENGTH`: change the minimun length of the title of the PR
- `BLOCK_LABELS`: define which label will block a PR (coma separated strings)
## Info
This little project is part of the [#NoServerNovember challenge](https://serverless.com/blog/no-server-november-challenge/).