doc: improve the SIG doc with the text from the ietf drafts #383
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check the pull request title | |
| on: | |
| pull_request: | |
| types: [opened, edited, reopened, synchronize] | |
| jobs: | |
| check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name : Check the PR title | |
| env: | |
| TITLE: ${{ github.event.pull_request.title }} | |
| run: | | |
| # Check that PR is of the form `<subsystem>: <lowercase message>` | |
| url='https://docs.scion.org/en/latest/dev/git.html#good-commit-messages' | |
| if [[ ! "$TITLE" =~ ^[a-z0-9,/-]*:[[:space:]] ]]; then | |
| echo '::error::The PR title should start with `<substystem>: `. See '"$url" | |
| exit 1 | |
| fi | |
| # Title should be lower case; initialisms and identifiers still occur occasionally and should be allowed. | |
| # -> enforce only the first word | |
| if [[ ! "$TITLE" =~ ^[a-z0-9,/-]*:[[:space:]][a-z] ]]; then | |
| echo '::error::The PR title should be lower case (enforced on first letter). See '"$url" | |
| exit 1 | |
| fi | |
| if [[ $TITLE =~ \.[[:space:]]*$ ]]; then | |
| echo '::error::The PR title should not end with a ".". See '"$url" | |
| exit 1 | |
| fi |