Add hovers for all GitResourceSource props
This commit is contained in:
Kris De Volder
@@ -0,0 +1 @@
|
||||
*Required.* The branch to track.
|
||||
@@ -0,0 +1,9 @@
|
||||
*Optional.* Array of GPG public key ids that
|
||||
the resource will check against to verify the commit (details below). The
|
||||
corresponding keys will be fetched from the key server specified in
|
||||
`gpg_keyserver`. The ids can be short id, long id or fingerprint.
|
||||
|
||||
If `commit_verification_keys` or `commit_verification_key_ids` is specified in
|
||||
the source configuration, it will additionally verify that the resulting commit
|
||||
has been GPG signed by one of the specified keys. It will error if this is not
|
||||
the case.
|
||||
@@ -0,0 +1,7 @@
|
||||
*Optional.* Array of GPG public keys that the
|
||||
resource will check against to verify the commit.
|
||||
|
||||
If `commit_verification_keys` or `commit_verification_key_ids` is specified in
|
||||
the source configuration, it will additionally verify that the resulting commit
|
||||
has been GPG signed by one of the specified keys. It will error if this is not
|
||||
the case.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* Allows for commits that have been labeled with `[ci skip]` or `[skip ci]`
|
||||
previously to be discovered by the resource.
|
||||
@@ -0,0 +1,7 @@
|
||||
*Optional.* If specified as (list of pairs `name` and `value`)
|
||||
it will configure git global options, setting each name with each value.
|
||||
|
||||
This can be useful to set options like `credential.helper` or similar.
|
||||
|
||||
See the [`git-config(1)` manual page](https://www.kernel.org/pub/software/scm/git/docs/git-config.html)
|
||||
for more information and documentation of existing git options.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* GPG keyserver to download the public keys from.
|
||||
Defaults to `hkp:///keys.gnupg.net/`.
|
||||
@@ -0,0 +1,10 @@
|
||||
*Optional.* A list of glob patterns. The inverse of `paths`; changes
|
||||
to the specified files are ignored.
|
||||
|
||||
Note that if you want to push commits that change these files via a `put`,
|
||||
the commit will still be "detected", as [`check` and `put` both introduce
|
||||
versions](https://concourse.ci/pipeline-mechanics.html#collecting-versions).
|
||||
To avoid this you should define a second resource that you use for commits
|
||||
that change files that you don't want to feed back into your pipeline - think
|
||||
of one as read-only (with `ignore_paths`) and one as write-only (which
|
||||
shouldn't need it).
|
||||
@@ -0,0 +1,3 @@
|
||||
*Optional.* Password for HTTP(S) auth when pulling/pushing.
|
||||
|
||||
Note: You can also use pipeline templating to hide this password in source control. (For more information: https://concourse.ci/fly-set-pipeline.html)
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* If specified (as a list of glob patterns), only changes
|
||||
to the specified files will yield new versions from `check`.
|
||||
@@ -0,0 +1,12 @@
|
||||
*Optional.* Private key to use when pulling/pushing.
|
||||
|
||||
Example:
|
||||
|
||||
private_key: |
|
||||
-----BEGIN RSA PRIVATE KEY-----
|
||||
MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
|
||||
<Lots more text>
|
||||
DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
|
||||
-----END RSA PRIVATE KEY-----
|
||||
|
||||
Note: You can also use pipeline templating to hide this private key in source control. (For more information: https://concourse.ci/fly-set-pipeline.html)
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* Skips git ssl verification by exporting
|
||||
`GIT_SSL_NO_VERIFY=true`.
|
||||
@@ -0,0 +1,4 @@
|
||||
`tag_filter`: *Optional.* If specified, the resource will only detect commits
|
||||
that have a tag matching the specified expression. Patterns are
|
||||
[glob(7)](http://man7.org/linux/man-pages/man7/glob.7.html) compatible (as
|
||||
in, bash compatible).
|
||||
@@ -0,0 +1,3 @@
|
||||
*Optional.* Username for HTTP(S) auth when pulling/pushing.
|
||||
This is needed when only HTTP/HTTPS protocol for git is available (which does not support private key auth)
|
||||
and auth is required.
|
||||
@@ -718,6 +718,20 @@ public class PipelineYamlEditorTest {
|
||||
,
|
||||
"username: <*>"
|
||||
);
|
||||
|
||||
assertContextualCompletions(
|
||||
"resources:\n" +
|
||||
"- name: the-repo\n" +
|
||||
" type: git\n" +
|
||||
" source:\n" +
|
||||
" git_config:\n" +
|
||||
" - <*>"
|
||||
, // =============
|
||||
"<*>"
|
||||
, // ==>
|
||||
"name: <*>",
|
||||
"value: <*>"
|
||||
);
|
||||
}
|
||||
|
||||
@Test public void gitResourceSourceHovers() throws Exception {
|
||||
@@ -745,6 +759,18 @@ public class PipelineYamlEditorTest {
|
||||
" gpg_keyserver: hkp://somekeyserver.net"
|
||||
);
|
||||
editor.assertHoverContains("uri", "*Required.* The location of the repository.");
|
||||
editor.assertHoverContains("branch", "The branch to track");
|
||||
editor.assertHoverContains("private_key", "Private key to use when pulling/pushing");
|
||||
editor.assertHoverContains("username", "Username for HTTP(S) auth");
|
||||
editor.assertHoverContains("password", "Password for HTTP(S) auth");
|
||||
editor.assertHoverContains("paths", "a list of glob patterns");
|
||||
editor.assertHoverContains("ignore_paths", "The inverse of `paths`");
|
||||
editor.assertHoverContains("skip_ssl_verification", "Skips git ssl verification");
|
||||
editor.assertHoverContains("tag_filter", "the resource will only detect commits");
|
||||
editor.assertHoverContains("git_config", "configure git global options");
|
||||
editor.assertHoverContains("disable_ci_skip", "Allows for commits that have been labeled with `[ci skip]`");
|
||||
editor.assertHoverContains("commit_verification_keys", "Array of GPG public keys");
|
||||
editor.assertHoverContains("commit_verification_key_ids", "Array of GPG public key ids");
|
||||
}
|
||||
|
||||
@Test
|
||||
|
||||
Reference in New Issue
Block a user