Skip to content

Commit 6ba5298

Browse files
authored
Clarify * behavior in allow_policies and deny_policies (#181)
1 parent 6089334 commit 6ba5298

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ This can be changed, but it is heavily discouraged.
8484

8585
### Dependency format
8686

87-
| Field | Type | Required | Description | Example |
88-
|----------------|:---------|:----------|:------------------------------------------------------------------------------|:--------------------------------------------------|
89-
| url | String | Mandatory | An address of the repository to checkout protobuf files from | "github.com/coralogix/cx-api-users/" |
90-
| revision | String | Optional | A revision to checkout, this can either be a tagged version or a commit hash | v0.2 |
91-
| branch | Boolean | Optional | A branch to checkout, fetches last commit | feature/v2 |
92-
| protocol | String | Optional | A protocol to use: [ssh, https] | ssh |
93-
| allow_policies | [String] | Optional | Allow policy rules | "/prefix/*", "*/subpath/*", "/path/to/file.proto" |
94-
| deny_policies | [String] | Optional | Deny policy rules | "/prefix/*", "*/subpath/*", "/path/to/file.proto" |
95-
| prune | bool | Optional | Whether to prune unneeded transitive proto files | true /false |
96-
| transitive | bool | Optional | Flags this dependency as transitive | true /false |
97-
| content_roots | [String] | Optional | Which subdirectories to import from | ["/myservice", "/com/org/client"] |
87+
| Field | Type | Required | Description | Example |
88+
|----------------|:---------|:----------|:-----------------------------------------------------------------------------------|:--------------------------------------------------|
89+
| url | String | Mandatory | An address of the repository to checkout protobuf files from | "github.com/coralogix/cx-api-users/" |
90+
| revision | String | Optional | A revision to checkout, this can either be a tagged version or a commit hash | v0.2 |
91+
| branch | Boolean | Optional | A branch to checkout, fetches last commit | feature/v2 |
92+
| protocol | String | Optional | A protocol to use: [ssh, https] | ssh |
93+
| allow_policies | [String] | Optional | Allow policy rules (`*` at the beginning or end matches arbitrary directory depth) | "/prefix/*", "*/subpath/*", "/path/to/file.proto" |
94+
| deny_policies | [String] | Optional | Deny policy rules (`*` at the beginning or end matches arbitrary directory depth) | "/prefix/*", "*/subpath/*", "/path/to/file.proto" |
95+
| prune | bool | Optional | Whether to prune unneeded transitive proto files | true /false |
96+
| transitive | bool | Optional | Flags this dependency as transitive | true /false |
97+
| content_roots | [String] | Optional | Which subdirectories to import from | ["/myservice", "/com/org/client"] |
9898

9999
### Protofetch dependency toml example
100100

0 commit comments

Comments
 (0)