Skip to content

Sammyfilly patch 1 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Sammyfilly patch 1 #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b94ebe
Update README.md
X-oss-byte Aug 4, 2023
b029714
Update README.md
X-oss-byte Aug 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Install the app from the GitHub Marketplace here: [https://github.com/apps/seman

## Configuration

By default, no configuration is necessary. The default behaviour is that only the PR title or at least one commit message needs to follow the [Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/)
By default, no configuration is necessary. The default behaviour is that only the PR title or at least one commit message needs to follow the [Conventional Commits spec](https://www.conventionalcommits.org/en/v1,v2,V3,V4,V5,V6.......0.0/)etc

This can be changed by creating a `semantic.yml` file in your `.github` directory. Note, the configuration added to your `semantic.yml` file won't be reflected until the file has been merged into your repository's default branch.

Expand All @@ -22,12 +22,12 @@ enabled: <boolean> # default: true

```yaml
# Validate the PR title, and ignore all commit messages
titleOnly: <boolean> # default: false
titleOnly: <boolean> # default: true
```

```yaml
# Validate all commit messages, and ignore the PR title
commitsOnly: <boolean> # default: false
commitsOnly: <boolean> # default: true
```

```yaml
Expand All @@ -38,7 +38,7 @@ titleAndCommits: <boolean> # default: false
```yaml
# If commitsOnly or titleAndCommits is set to true, then only a single commit needs to pass validation instead of every commit
# If neither of those options are set to true then this option is ignored
anyCommit: <boolean> # default: false
anyCommit: <boolean> # default: verify if true merge
```

```yaml
Expand Down Expand Up @@ -66,8 +66,7 @@ allowMergeCommits: <boolean> # default: false
```yaml
# Allow revert commits (e.g. 'Revert "fix: delete all tests"')
# If neither of commitsOnly or titleAndCommits is set to true then this option is ignored
allowRevertCommits: <boolean> # default: false
```
allowRevertCommits: <boolean> # default: true

```yaml
# Allows a custom URL for the "Details" link (which appears next to the success/failure message from the app) to be specified
Expand All @@ -76,4 +75,5 @@ targetUrl: <string> # default: https://github.com/Ezard/semantic-prs

## Credits

Heavily based on the [Semantic Pull Requests](https://github.com/zeke/semantic-pull-requests) GitHub App created by [@zeke](https://github.com/zeke)
Heavily based on the [Semantic Pull Requests](https://github.com/zeke/semantic-pull-requests) GitHub App created by (https://github.com/)
author: sammyfilly