multi-gitter allows you to make changes in multiple repositories simultaneously. This is achieved by running a script or program in the context of multiple repositories. If any changes are made, a pull request is created that can be merged manually by the set reviewers, or automatically by multi-gitter when CI pipelines has completed successfully.
Are you a bash-guru or simply prefer your scripting in Node.js? It doesn't matter, since multi-gitter support any type of script or program. If you can script it to run in one place, you can run it in all your repositories with one command!
- Syncing a file (like a PR-template)
- Programmatic refactoring
- Updating a dependency
- Automatically fixing linting issues
- Search and replace
- Anything else you are able to script!
$ multi-gitter run ./my-script.sh -O my-org -m "Commit message" -B branch-name
Make sure the script has execution permissions before running it (chmod +x ./my-script.sh
)
If you are running an interpreted language or similar, it's important to specify the path as an absolute value (since the script will be run in the context of each repository). Using the $PWD
variable helps with this.
$ multi-gitter run "python $PWD/run.py" -O my-org -m "Commit message" -B branch-name
$ multi-gitter run "node $PWD/script.js" -R repo1 -R repo2 -m "Commit message" -B branch-name
$ multi-gitter run "go run $PWD/main.go" -U my-user -m "Commit message" -B branch-name
You might want to test your changes before creating commits. The --dry-run
provides an easy way to test without actually making any modifications. It works well with setting the log level to debug
with --log-level=debug
to also print the changes that would have been made.
$ multi-gitter run ./script.sh --dry-run --log-level=debug -O my-org -m "Commit message" -B branch-name
If you are using Mac or Linux, Homebrew is an easy way of installing multi-gitter.
brew install lindell/multi-gitter/multi-gitter
Find the binary for your operating system from the release page and download it.
To automatically install the latest version
curl -s https://raw.githubusercontent.com/lindell/multi-gitter/master/install.sh | sh
You can also install from source with go install
, this is not recommended for most cases.
go install github.com/lindell/multi-gitter@latest
To use multi-gitter, a token that is allowed to list repositories and create pull requests is needed. This token can either be set in the GITHUB_TOKEN
, GITLAB_TOKEN
, GITEA_TOKEN
environment variable, or by using the --token
flag.
How to generate a GitHub personal access token. Make sure to give to repo
permissions.
How to generate a GitLab personal access token. Make sure to give to it the api
permission.
In Gitea, access tokens can be generated under Settings -> Applications -> Manage Access Tokens
All configuration in multi-gitter can be done through command line flags, configuration files or a mix of both. If you want to use a configuration file, simply use the --config=./path/to/config.yaml
. Multi-gitter will also read from the file ~/.multi-gitter/config
and take and configuration from there. The priority of configs are first flags, then defined config file and lastly the static config file.
All available run options
# The username of the assignees to be added on the pull request.
assignees:
- example
# Email of the committer. If not set, the global git config setting will be used.
author-email:
# Name of the committer. If not set, the global git config setting will be used.
author-name:
# The branch which the changes will be based on.
base-branch:
# Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.
base-url:
# The name of the branch where changes are committed.
branch: multi-gitter-branch
# The commit message. Will default to title + body if none is set.
commit-message:
# The maximum number of concurrent runs.
concurrent: 1
# What should happen if the branch already exist.
# Available values:
# skip: Skip making any changes to the existing branch and do not create a new pull request.
# replace: Replace the existing content of the branch by force pushing any new changes, then reuse any existing pull request, or create a new one if none exist.
conflict-strategy: skip
# Create pull request(s) as draft.
draft: false
# Run without pushing changes or creating pull requests.
dry-run: false
# Limit fetching to the specified number of commits. Set to 0 for no limit.
fetch-depth: 1
# Fork the repository instead of creating a new branch on the same owner.
fork: false
# If set, make the fork to the defined value. Default behavior is for the fork to be on the logged in user.
fork-owner:
# The type of git implementation to use.
# Available values:
# go: Uses go-git, a Go native implementation of git. This is compiled with the multi-gitter binary, and no extra dependencies are needed.
# cmd: Calls out to the git command. This requires git to be installed and available with by calling "git".
git-type: go
# The name of a GitLab organization. All repositories in that group will be used.
group:
- example
# Include GitLab subgroups when using the --group flag.
include-subgroups: false
# Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
insecure: false
# Take manual decision before committing any change. Requires git to be installed.
interactive: false
# Labels to be added to any created pull request.
labels:
- example
# The file where all logs should be printed to. "-" means stdout.
log-file: "-"
# The formatting of the logs. Available values: text, json, json-pretty.
log-format: text
# The level of logging that should be made. Available values: trace, debug, info, error.
log-level: info
# If this value is set, reviewers will be randomized.
max-reviewers: 0
# If this value is set, team reviewers will be randomized
max-team-reviewers: 0
# The name of a GitHub organization. All repositories in that organization will be used.
org:
- example
# The file that the output of the script should be outputted to. "-" means stdout.
output: "-"
# The platform that is used. Available values: github, gitlab, gitea, bitbucket_server.
platform: github
# The body of the commit message. Will default to everything but the first line of the commit message if none is set.
pr-body:
# The title of the PR. Will default to the first line of the commit message if none is set.
pr-title:
# The name, including owner of a GitLab project in the format "ownerName/repoName".
project:
- group/project
# The name, including owner of a GitHub repository in the format "ownerName/repoName".
repo:
- my-org/js-repo
- other-org/python-repo
# The username of the reviewers to be added on the pull request.
reviewers:
- example
# Skip repositories which are forks.
skip-forks: false
# Skip pull request and directly push to the branch.
skip-pr: false
# Skip changes on specified repositories, the name is including the owner of repository in the format "ownerName/repoName".
skip-repo:
- example
# 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.
ssh-auth: false
# Github team names of the reviewers, in format: 'org/team'
team-reviewers:
- example
# 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.
token:
# The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
topic:
- example
# The name of a user. All repositories owned by that user will be used.
user:
- example
# The Bitbucket server username.
username:
All available merge options
# Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.
base-url:
# The name of the branch where changes are committed.
branch: multi-gitter-branch
# Use pull requests made from forks instead of from the same repository.
fork: false
# If set, use forks from the defined value instead of the logged in user.
fork-owner:
# The name of a GitLab organization. All repositories in that group will be used.
group:
- example
# Include GitLab subgroups when using the --group flag.
include-subgroups: false
# Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
insecure: false
# The file where all logs should be printed to. "-" means stdout.
log-file: "-"
# The formatting of the logs. Available values: text, json, json-pretty.
log-format: text
# The level of logging that should be made. Available values: trace, debug, info, error.
log-level: info
# The type of merge that should be done (GitHub). Multiple types can be used as backup strategies if the first one is not allowed.
merge-type:
- merge
- squash
- rebase
# The name of a GitHub organization. All repositories in that organization will be used.
org:
- example
# The platform that is used. Available values: github, gitlab, gitea, bitbucket_server.
platform: github
# The name, including owner of a GitLab project in the format "ownerName/repoName".
project:
- group/project
# The name, including owner of a GitHub repository in the format "ownerName/repoName".
repo:
- my-org/js-repo
- other-org/python-repo
# Skip repositories which are forks.
skip-forks: false
# 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.
ssh-auth: false
# 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.
token:
# The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
topic:
- example
# The name of a user. All repositories owned by that user will be used.
user:
- example
# The Bitbucket server username.
username:
All available status options
# Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.
base-url:
# The name of the branch where changes are committed.
branch: multi-gitter-branch
# Use pull requests made from forks instead of from the same repository.
fork: false
# If set, use forks from the defined value instead of the logged in user.
fork-owner:
# The name of a GitLab organization. All repositories in that group will be used.
group:
- example
# Include GitLab subgroups when using the --group flag.
include-subgroups: false
# Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
insecure: false
# The file where all logs should be printed to. "-" means stdout.
log-file: "-"
# The formatting of the logs. Available values: text, json, json-pretty.
log-format: text
# The level of logging that should be made. Available values: trace, debug, info, error.
log-level: info
# The name of a GitHub organization. All repositories in that organization will be used.
org:
- example
# The file that the output of the script should be outputted to. "-" means stdout.
output: "-"
# The platform that is used. Available values: github, gitlab, gitea, bitbucket_server.
platform: github
# The name, including owner of a GitLab project in the format "ownerName/repoName".
project:
- group/project
# The name, including owner of a GitHub repository in the format "ownerName/repoName".
repo:
- my-org/js-repo
- other-org/python-repo
# Skip repositories which are forks.
skip-forks: false
# 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.
ssh-auth: false
# 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.
token:
# The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
topic:
- example
# The name of a user. All repositories owned by that user will be used.
user:
- example
# The Bitbucket server username.
username:
All available close options
# Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.
base-url:
# The name of the branch where changes are committed.
branch: multi-gitter-branch
# Use pull requests made from forks instead of from the same repository.
fork: false
# If set, use forks from the defined value instead of the logged in user.
fork-owner:
# The name of a GitLab organization. All repositories in that group will be used.
group:
- example
# Include GitLab subgroups when using the --group flag.
include-subgroups: false
# Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
insecure: false
# The file where all logs should be printed to. "-" means stdout.
log-file: "-"
# The formatting of the logs. Available values: text, json, json-pretty.
log-format: text
# The level of logging that should be made. Available values: trace, debug, info, error.
log-level: info
# The name of a GitHub organization. All repositories in that organization will be used.
org:
- example
# The platform that is used. Available values: github, gitlab, gitea, bitbucket_server.
platform: github
# The name, including owner of a GitLab project in the format "ownerName/repoName".
project:
- group/project
# The name, including owner of a GitHub repository in the format "ownerName/repoName".
repo:
- my-org/js-repo
- other-org/python-repo
# Skip repositories which are forks.
skip-forks: false
# 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.
ssh-auth: false
# 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.
token:
# The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
topic:
- example
# The name of a user. All repositories owned by that user will be used.
user:
- example
# The Bitbucket server username.
username:
All available print options
# Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.
base-url:
# The maximum number of concurrent runs.
concurrent: 1
# The file that the output of the script should be outputted to. "-" means stderr.
error-output: "-"
# Limit fetching to the specified number of commits. Set to 0 for no limit.
fetch-depth: 1
# The type of git implementation to use.
# Available values:
# go: Uses go-git, a Go native implementation of git. This is compiled with the multi-gitter binary, and no extra dependencies are needed.
# cmd: Calls out to the git command. This requires git to be installed and available with by calling "git".
git-type: go
# The name of a GitLab organization. All repositories in that group will be used.
group:
- example
# Include GitLab subgroups when using the --group flag.
include-subgroups: false
# Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
insecure: false
# The file where all logs should be printed to. "-" means stdout.
log-file:
# The formatting of the logs. Available values: text, json, json-pretty.
log-format: text
# The level of logging that should be made. Available values: trace, debug, info, error.
log-level: info
# The name of a GitHub organization. All repositories in that organization will be used.
org:
- example
# The file that the output of the script should be outputted to. "-" means stdout.
output: "-"
# The platform that is used. Available values: github, gitlab, gitea, bitbucket_server.
platform: github
# The name, including owner of a GitLab project in the format "ownerName/repoName".
project:
- group/project
# The name, including owner of a GitHub repository in the format "ownerName/repoName".
repo:
- my-org/js-repo
- other-org/python-repo
# Skip repositories which are forks.
skip-forks: false
# 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.
ssh-auth: false
# 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.
token:
# The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
topic:
- example
# The name of a user. All repositories owned by that user will be used.
user:
- example
# The Bitbucket server username.
username:
- run Clones multiple repositories, run a script in that directory, and creates a PR with those changes.
- merge Merge pull requests.
- status Get the status of pull requests.
- close Close pull requests.
- print Clones multiple repositories, run a script in that directory, and prints the output of each run.
This command will clone down multiple repositories. For each of those repositories, the script will be run in the context of that repository. If the script finished with a zero exit code, and the script resulted in file changes, a pull request will be created with.
When the script is invoked, these environment variables are set:
- REPOSITORY will be set to the name of the repository currently being executed
- DRY_RUN will be set =true, when running in with the --dry-run flag, otherwise it's absent
Usage:
multi-gitter run [script path] [flags]
Flags:
-a, --assignees strings The username of the assignees to be added on the pull request.
--author-email string Email of the committer. If not set, the global git config setting will be used.
--author-name string Name of the committer. If not set, the global git config setting will be used.
--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")
-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.
--conflict-strategy string What should happen if the branch already exist.
Available values:
skip: Skip making any changes to the existing branch and do not create a new pull request.
replace: Replace the existing content of the branch by force pushing any new changes, then reuse any existing pull request, or create a new one if none exist.
(default "skip")
--draft Create pull request(s) as draft.
-d, --dry-run Run without pushing changes or creating pull requests.
-f, --fetch-depth int Limit fetching to the specified number of commits. Set to 0 for no limit. (default 1)
--fork Fork the repository instead of creating a new branch on the same owner.
--fork-owner string If set, make the fork to the defined value. Default behavior is for the fork to be on the logged in user.
--git-type string The type of git implementation to use.
Available values:
go: Uses go-git, a Go native implementation of git. This is compiled with the multi-gitter binary, and no extra dependencies are needed.
cmd: Calls out to the git command. This requires git to be installed and available with by calling "git".
(default "go")
-G, --group strings The name of a GitLab organization. All repositories in that group will be used.
--include-subgroups Include GitLab subgroups when using the --group flag.
--insecure Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
-i, --interactive Take manual decision before committing any change. Requires git to be installed.
--labels strings Labels to be added to any created pull request.
--log-file string The file where all logs should be printed to. "-" means stdout. (default "-")
--log-format string The formatting of the logs. Available values: text, json, json-pretty. (default "text")
-L, --log-level string The level of logging that should be made. Available values: trace, debug, info, error. (default "info")
-M, --max-reviewers int If this value is set, reviewers will be randomized.
--max-team-reviewers int If this value is set, team reviewers will be randomized
-O, --org strings The name of a GitHub organization. All repositories in that organization will be used.
-o, --output string The file that the output of the script should be outputted to. "-" means stdout. (default "-")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea, bitbucket_server. (default "github")
-b, --pr-body string The body of the commit message. Will default to everything but the first line of the commit message if none is set.
-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".
-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.
-s, --skip-repo strings Skip changes on specified repositories, the name is including the owner of repository in the format "ownerName/repoName".
--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.
--team-reviewers strings Github team names of the reviewers, in format: 'org/team'
-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.
--topic strings The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
-U, --user strings The name of a user. All repositories owned by that user will be used.
-u, --username string The Bitbucket server username.
Merge pull requests with a specified branch name in an organization and with specified conditions.
Usage:
multi-gitter merge [flags]
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")
--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.
-G, --group strings The name of a GitLab organization. All repositories in that group will be used.
--include-subgroups Include GitLab subgroups when using the --group flag.
--insecure Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
--log-file string The file where all logs should be printed to. "-" means stdout. (default "-")
--log-format string The formatting of the logs. Available values: text, json, json-pretty. (default "text")
-L, --log-level string The level of logging that should be made. Available values: trace, debug, info, error. (default "info")
--merge-type strings The type of merge that should be done (GitHub). Multiple types can be used as backup strategies if the first one is not allowed. (default [merge,squash,rebase])
-O, --org strings The name of a GitHub organization. All repositories in that organization will be used.
-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".
--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.
--topic strings The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
-U, --user strings The name of a user. All repositories owned by that user will be used.
-u, --username string The Bitbucket server username.
Get the status of all pull requests with a specified branch name in an organization.
Usage:
multi-gitter status [flags]
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")
--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.
-G, --group strings The name of a GitLab organization. All repositories in that group will be used.
--include-subgroups Include GitLab subgroups when using the --group flag.
--insecure Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
--log-file string The file where all logs should be printed to. "-" means stdout. (default "-")
--log-format string The formatting of the logs. Available values: text, json, json-pretty. (default "text")
-L, --log-level string The level of logging that should be made. Available values: trace, debug, info, error. (default "info")
-O, --org strings The name of a GitHub organization. All repositories in that organization will be used.
-o, --output string The file that the output of the script should be outputted to. "-" means stdout. (default "-")
-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".
--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.
--topic strings The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
-U, --user strings The name of a user. All repositories owned by that user will be used.
-u, --username string The Bitbucket server username.
Close pull requests with a specified branch name in an organization and with specified conditions.
Usage:
multi-gitter close [flags]
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")
--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.
-G, --group strings The name of a GitLab organization. All repositories in that group will be used.
--include-subgroups Include GitLab subgroups when using the --group flag.
--insecure Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
--log-file string The file where all logs should be printed to. "-" means stdout. (default "-")
--log-format string The formatting of the logs. Available values: text, json, json-pretty. (default "text")
-L, --log-level string The level of logging that should be made. Available values: trace, debug, info, error. (default "info")
-O, --org strings The name of a GitHub organization. All repositories in that organization will be used.
-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".
--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.
--topic strings The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
-U, --user strings The name of a user. All repositories owned by that user will be used.
-u, --username string The Bitbucket server username.
This command will clone down multiple repositories. For each of those repositories, the script will be run in the context of that repository. The output of each script run in each repo will be printed, by default to stdout and stderr, but it can be configured to files as well.
When the script is invoked, these environment variables are set:
- REPOSITORY will be set to the name of the repository currently being executed
Usage:
multi-gitter print [script path] [flags]
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.
-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 "-")
-f, --fetch-depth int Limit fetching to the specified number of commits. Set to 0 for no limit. (default 1)
--git-type string The type of git implementation to use.
Available values:
go: Uses go-git, a Go native implementation of git. This is compiled with the multi-gitter binary, and no extra dependencies are needed.
cmd: Calls out to the git command. This requires git to be installed and available with by calling "git".
(default "go")
-G, --group strings The name of a GitLab organization. All repositories in that group will be used.
--include-subgroups Include GitLab subgroups when using the --group flag.
--insecure Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.
--log-file string The file where all logs should be printed to. "-" means stdout.
--log-format string The formatting of the logs. Available values: text, json, json-pretty. (default "text")
-L, --log-level string The level of logging that should be made. Available values: trace, debug, info, error. (default "info")
-O, --org strings The name of a GitHub organization. All repositories in that organization will be used.
-o, --output string The file that the output of the script should be outputted to. "-" means stdout. (default "-")
-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".
--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.
--topic strings The topic of a GitHub/GitLab/Gitea repository. All repositories having at least one matching topic are targeted.
-U, --user strings The name of a user. All repositories owned by that user will be used.
-u, --username string The Bitbucket server username.
Clone all repositories locally while maintaining their group folder structure
#!/bin/bash
# This script should be used with the print command.
mkdir -p ~/multi-gitter/$REPOSITORY
cp -r . ~/multi-gitter/$REPOSITORY
Replace a file if it exist
#!/bin/bash
REPLACE_FILE=~/test/pull_request_template.md # The file that should replace the file in the repo, must be an absolute path
FILE=.github/pull_request_template.md # Relative from any repos root
# Don't replace this file if it does not already exist in the repo
if [ ! -f "$FILE" ]; then
exit 1
fi
cp $REPLACE_FILE $FILE
Replace text in all files
#!/bin/bash
# Assuming you are using gnu sed, if you are running this on a mac, please see https://stackoverflow.com/questions/4247068/sed-command-with-i-option-failing-on-mac-but-works-on-linux
find ./ -type f -exec sed -i -e 's/apple/orange/g' {} \;
Replace all instances of empty interface with any
#!/bin/bash
gofmt -r 'interface{} -> any' -w **/*.go
Fix the ioutil deprecation
#!/bin/bash
gofmt -w -r 'ioutil.Discard -> io.Discard' .
gofmt -w -r 'ioutil.NopCloser -> io.NopCloser' .
gofmt -w -r 'ioutil.ReadAll -> io.ReadAll' .
gofmt -w -r 'ioutil.ReadFile -> os.ReadFile' .
gofmt -w -r 'ioutil.TempDir -> os.MkdirTemp' .
gofmt -w -r 'ioutil.TempFile -> os.CreateTemp' .
gofmt -w -r 'ioutil.WriteFile -> os.WriteFile' .
gofmt -w -r 'ioutil.ReadDir -> os.ReadDir ' . # (note: returns a slice of os.DirEntry rather than a slice of fs.FileInfo)
goimports -w .
Fix linting problems in all your go repositories
#!/bin/bash
golangci-lint run ./... --fix
Updates a go module to a new (patch/minor) version
#!/bin/bash
### Change these values ###
MODULE=github.com/go-git/go-git/v5
VERSION=v5.1.0
# Check if the module already exist, abort if it does not
go list -m $MODULE &> /dev/null
status_code=$?
if [ $status_code -ne 0 ]; then
echo "Module \"$MODULE\" does not exist"
exit 1
fi
go get $MODULE@$VERSION
Upgrade Go version in go modules
#!/bin/bash
go mod edit -go 1.18
go mod tidy
Updates a npm dependency if it does exist
#!/bin/bash
### Change these values ###
PACKAGE=webpack
VERSION=4.43.0
if [ ! -f "package.json" ]; then
echo "package.json does not exist"
exit 1
fi
# Check if the package already exist (without having to install all packages first), abort if it does not
current_version=`jq ".dependencies[\"$PACKAGE\"]" package.json`
if [ "$current_version" == "null" ];
then
echo "Package \"$PACKAGE\" does not exist"
exit 2
fi
npm install --save $PACKAGE@$VERSION
Simple replace using node
const { readFile, writeFile } = require("fs").promises;
async function replace() {
let data = await readFile("./README.md", "utf8");
data = data.replace("apple", "orange");
await writeFile("./README.md", data, "utf8");
}
replace();
Do you have a nice script that might be useful to others? Please create a PR that adds it to the examples folder.