Skip to content

docs: explain required versioned regex input #108

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
vjymisal0 wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −0
Open

docs: explain required versioned regex input #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ jobs:
repo-token: ${{ github.token }}
```

`enable-versioned-regex` is required and has no default; omitting it causes the action to fail. Set it to `0` to use the file at `configuration-path` directly. Set it to `1` to select a versioned configuration file using the first capture group of `versioned-regex` matched against the issue body, as shown in the [versioned issue templates example](#example-using-versioned-issue-templates). Versioning lets older issues keep using the regular expressions for their original template when templates change.

`not-before` is optional and will result in any issues prior to this timestamp to be ignored.

### Example using versioned issue templates
Expand Down Expand Up @@ -159,6 +161,7 @@ jobs:
- uses: github/issue-labeler@v3.5 #May not be the latest version
with:
configuration-path: .github/labeler.yml
enable-versioned-regex: 0
include-title: 1
include-body: 0
```
Expand Down