https://github.com/jontze/semantic-commit-pr
https://github.com/jontze/semantic-commit-pr
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jontze/semantic-commit-pr
- Owner: jontze
- License: isc
- Created: 2024-04-11T18:28:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T19:52:48.000Z (3 months ago)
- Last Synced: 2025-03-06T15:15:48.581Z (3 months ago)
- Language: TypeScript
- Size: 814 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Semantic Commit Analyzer for PRs
> A GitHub App built with [Probot](https://github.com/probot/probot)
This is a library that exposes a single Probot Application function that can be
used in Probot Apps to analyze the commits in PRs to determine if they follow
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification.
This project is based and heavily inspired by [zeke's Probot
App](https://github.com/zeke/semantic-pull-requests) that sadly is no longer
maintained.
> **Note:** I wrote this mainly for my own personal use. If you want to use it
> in production, it might eat your laundry. Do it at your own risk.
## Usage
```typescript
import SemanticCommitPR from "@jontze/semantic-commit-pr";
import { createProbot } from "probot";
// https://probot.github.io/docs/development/#run-probot-programmatically
// Choose your way to instantiate Probot
const probotApp = createProbot();
// Load the Application Function into your App
probotApp.load(SemanticCommitPR);
// Start your Probot App
```
## License
[ISC](LICENSE) © 2024 jontze