Skip to content

Commit

Permalink
Update querymatchers documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@coenm
coenm committed May 2, 2024
1 parent 693be0d commit c177a96
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
20 changes: 10 additions & 10 deletions docs_new/querymatchers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ RepoM uses query matchers to check if a given term matches a given repository.

The following query matchers are currently implemented:

| Matcher type | Term types | Term | Accepted values | Description |
|---------------------------|----------------------------|------|----------------------------------------|--------------------------------------------------------------------------------------------|
| FreeTextMatcher | FreeText | | * | Checks if the free text matches a tag, else if the repositiry name contains the free text. |
| NameMatcher | SimpleTerm, StartsWithTerm | name | * | Checks if the repository name equals the given name |
| TagMatcher | SimpleTerm, StartsWithTerm | tag | * | Checks if the repository tags contain the given tag |
| IsPinnedMatcher | SimpleTerm | is | pinned | Checks if a repository is pinned or not |
| IsBareRepositoryMatcher | SimpleTerm | is | bare | Returns true if a repository is a bare repository. |
| IsBehindMatcher | SimpleTerm | is | behind | Returns true if a repository has pending updates from the remote. |
| HasUnPushedChangesMatcher | SimpleTerm | has | changes | Returns true if there are changed uncommitted files. |
| HasPullRequestsMatcher | SimpleTerm | has | [pr, prs, pull-request, pull-requests] | Returns true if there are known pull requests available in Azure DevOps. |
| Term types | Term | Accepted values | Description |
|----------------------------|------|----------------------------------------|--------------------------------------------------------------------------------------------|
| FreeText | | * | Checks if the free text matches a tag, else if the repositiry name contains the free text. |
| SimpleTerm, StartsWithTerm | name | * | Checks if the repository name equals the given name |
| SimpleTerm, StartsWithTerm | tag | * | Checks if the repository tags contain the given tag |
| SimpleTerm | is | pinned | Checks if a repository is pinned or not |
| SimpleTerm | is | bare | Returns true if a repository is a bare repository. |
| SimpleTerm | is | behind | Returns true if a repository has pending updates from the remote. |
| SimpleTerm | has | changes | Returns true if there are changed uncommitted files. |
| SimpleTerm | has | [pr, prs, pull-request, pull-requests] | Returns true if there are known pull requests available in Azure DevOps. |
1 change: 0 additions & 1 deletion docs_new/search.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Currently, the following query parsers are available:

sdf


### Query matchers

`IQueryMatcher`
Expand Down

0 comments on commit c177a96

Please sign in to comment.