From 81d60d8438367356ffd1070b69c381c0ba5cfdcd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 9 Nov 2023 19:30:51 +0000 Subject: [PATCH] docs: updated readme Co-authored-by: James Telfer <792299+jamestelfer@users.noreply.github.com> --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8f098bb9..23ededea 100755 --- a/README.md +++ b/README.md @@ -119,6 +119,9 @@ base-url: # The name of the branch where changes are committed. branch: multi-gitter-branch +# Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. +code-search: + # The commit message. Will default to title + body if none is set. commit-message: @@ -212,7 +215,7 @@ repo: - my-org/js-repo - other-org/python-repo -# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories +# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. repo-search: # The username of the reviewers to be added on the pull request. @@ -263,6 +266,9 @@ base-url: # The name of the branch where changes are committed. branch: multi-gitter-branch +# Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. +code-search: + # Use pull requests made from forks instead of from the same repository. fork: false @@ -313,7 +319,7 @@ repo: - my-org/js-repo - other-org/python-repo -# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories +# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. repo-search: # Skip repositories which are forks. @@ -349,6 +355,9 @@ base-url: # The name of the branch where changes are committed. branch: multi-gitter-branch +# Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. +code-search: + # Use pull requests made from forks instead of from the same repository. fork: false @@ -396,7 +405,7 @@ repo: - my-org/js-repo - other-org/python-repo -# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories +# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. repo-search: # Skip repositories which are forks. @@ -432,6 +441,9 @@ base-url: # The name of the branch where changes are committed. branch: multi-gitter-branch +# Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. +code-search: + # Use pull requests made from forks instead of from the same repository. fork: false @@ -476,7 +488,7 @@ repo: - my-org/js-repo - other-org/python-repo -# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories +# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. repo-search: # Skip repositories which are forks. @@ -509,6 +521,9 @@ username: # Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. base-url: +# Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use `fork:true` to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. +code-search: + # The maximum number of concurrent runs. concurrent: 1 @@ -565,7 +580,7 @@ repo: - my-org/js-repo - other-org/python-repo -# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories +# Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use `fork:true` to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. repo-search: # Skip repositories which are forks. @@ -619,6 +634,7 @@ Flags: --base-branch string The branch which the changes will be based on. -g, --base-url string Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. -B, --branch string The name of the branch where changes are committed. (default "multi-gitter-branch") + --code-search fork:true Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use fork:true to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. -m, --commit-message string The commit message. Will default to title + body if none is set. -C, --concurrent int The maximum number of concurrent runs. (default 1) --config string Path of the config file. @@ -655,7 +671,7 @@ Flags: -t, --pr-title string The title of the PR. Will default to the first line of the commit message if none is set. -P, --project strings The name, including owner of a GitLab project in the format "ownerName/repoName". -R, --repo strings The name, including owner of a GitHub repository in the format "ownerName/repoName". - --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories + --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. -r, --reviewers strings The username of the reviewers to be added on the pull request. --skip-forks Skip repositories which are forks. --skip-pr Skip pull request and directly push to the branch. @@ -678,6 +694,7 @@ Usage: Flags: -g, --base-url string Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. -B, --branch string The name of the branch where changes are committed. (default "multi-gitter-branch") + --code-search fork:true Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use fork:true to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. --config string Path of the config file. --fork Use pull requests made from forks instead of from the same repository. --fork-owner string If set, use forks from the defined value instead of the logged in user. @@ -693,7 +710,7 @@ Flags: -p, --platform string The platform that is used. Available values: github, gitlab, gitea, bitbucket_server. (default "github") -P, --project strings The name, including owner of a GitLab project in the format "ownerName/repoName". -R, --repo strings The name, including owner of a GitHub repository in the format "ownerName/repoName". - --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories + --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. --skip-forks Skip repositories which are forks. --ssh-auth Use SSH cloning URL instead of HTTPS + token. This requires that a setup with ssh keys that have access to all repos and that the server is already in known_hosts. -T, --token string The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN environment variable. @@ -712,6 +729,7 @@ Usage: Flags: -g, --base-url string Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. -B, --branch string The name of the branch where changes are committed. (default "multi-gitter-branch") + --code-search fork:true Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use fork:true to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. --config string Path of the config file. --fork Use pull requests made from forks instead of from the same repository. --fork-owner string If set, use forks from the defined value instead of the logged in user. @@ -727,7 +745,7 @@ Flags: -p, --platform string The platform that is used. Available values: github, gitlab, gitea, bitbucket_server. (default "github") -P, --project strings The name, including owner of a GitLab project in the format "ownerName/repoName". -R, --repo strings The name, including owner of a GitHub repository in the format "ownerName/repoName". - --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories + --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. --skip-forks Skip repositories which are forks. --ssh-auth Use SSH cloning URL instead of HTTPS + token. This requires that a setup with ssh keys that have access to all repos and that the server is already in known_hosts. -T, --token string The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN environment variable. @@ -746,6 +764,7 @@ Usage: Flags: -g, --base-url string Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. -B, --branch string The name of the branch where changes are committed. (default "multi-gitter-branch") + --code-search fork:true Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use fork:true to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. --config string Path of the config file. --fork Use pull requests made from forks instead of from the same repository. --fork-owner string If set, use forks from the defined value instead of the logged in user. @@ -760,7 +779,7 @@ Flags: -p, --platform string The platform that is used. Available values: github, gitlab, gitea, bitbucket_server. (default "github") -P, --project strings The name, including owner of a GitLab project in the format "ownerName/repoName". -R, --repo strings The name, including owner of a GitHub repository in the format "ownerName/repoName". - --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories + --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. --skip-forks Skip repositories which are forks. --ssh-auth Use SSH cloning URL instead of HTTPS + token. This requires that a setup with ssh keys that have access to all repos and that the server is already in known_hosts. -T, --token string The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN environment variable. @@ -783,6 +802,7 @@ Usage: Flags: -g, --base-url string Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket. + --code-search fork:true Use a code search to find a set of repositories to target (GitHub only). Repeated results from a given repository will be ignored, forks are NOT included by default (use fork:true to include them). See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-code. -C, --concurrent int The maximum number of concurrent runs. (default 1) --config string Path of the config file. -E, --error-output string The file that the output of the script should be outputted to. "-" means stderr. (default "-") @@ -804,7 +824,7 @@ Flags: -p, --platform string The platform that is used. Available values: github, gitlab, gitea, bitbucket_server. (default "github") -P, --project strings The name, including owner of a GitLab project in the format "ownerName/repoName". -R, --repo strings The name, including owner of a GitHub repository in the format "ownerName/repoName". - --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories + --repo-search fork:true Use a repository search to find repositories to target (GitHub only). Forks are NOT included by default, use fork:true to include them. See the GitHub documentation for full syntax: https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories. --skip-forks Skip repositories which are forks. --ssh-auth Use SSH cloning URL instead of HTTPS + token. This requires that a setup with ssh keys that have access to all repos and that the server is already in known_hosts. -T, --token string The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN environment variable.