Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lindell committed Apr 25, 2021
1 parent 0f89791 commit 4482cbe
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ go get github.com/lindell/multi-gitter

## Token

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` or `GITLAB_TOKEN` environment variable, or by using the `--token` flag.
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.

### GitHub
[How to generate a GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). Make sure to give to `repo` permissions.
Expand All @@ -82,6 +82,10 @@ To use multi-gitter, a token that is allowed to list repositories and create pul

[How to generate a GitLab personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). Make sure to give to it the `api` permission.

### Gitea

In Gitea, access tokens can be generated under Settings -> Applications -> Manage Access Tokens

## Usage

* [run](#-usage-of-run) Clones multiple repositories, run a script in that directory, and creates a PR with those changes.
Expand Down Expand Up @@ -118,7 +122,7 @@ Flags:
-M, --max-reviewers int If this value is set, 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 (default "github")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea (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"
Expand All @@ -145,7 +149,7 @@ Flags:
-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 (default "github")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea (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"
-T, --token string The GitHub/GitLab personal access token. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN environment variable.
Expand All @@ -168,7 +172,7 @@ Flags:
-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 (default "github")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea (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"
-T, --token string The GitHub/GitLab personal access token. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN environment variable.
Expand All @@ -190,7 +194,7 @@ Flags:
--log-format string The formating 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 (default "github")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea (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"
-T, --token string The GitHub/GitLab personal access token. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN environment variable.
Expand Down Expand Up @@ -219,7 +223,7 @@ Flags:
-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 (default "github")
-p, --platform string The platform that is used. Available values: github, gitlab, gitea (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"
-T, --token string The GitHub/GitLab personal access token. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN environment variable.
Expand Down

0 comments on commit 4482cbe

Please sign in to comment.