Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update error message about installing GitHub CLI #25

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+17 −8
Open

Update error message about installing GitHub CLI #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cee4e67
Update doc and error message around installing github-cli
ardydedase Nov 13, 2023
74171c1
Update doc and error message around installing github-cli
ardydedase Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ If you provide a script Repository Mapper will run it on every repository you sp
It can help with things like:

* Running structured queries on every repository, E.g.
- Which repositories still use 'go dep'?
- How many repositories still depend on X version of this package?
- Find me all usages of the term 'X' across all repositories
- Which users contribute to which repositories?
- Which repositories still use 'go dep'?
- How many repositories still depend on X version of this package?
- Find me all usages of the term 'X' across all repositories
- Which users contribute to which repositories?

* Running scripts and creating pull requests on every repository. E.g.
- Auto upgrade X dependency in every repository
- Add this LICENCE file to every repository
- Auto upgrade X dependency in every repository
- Add this LICENCE file to every repository

## Installation

Expand All @@ -38,7 +38,11 @@ go install -mod=vendor
```

Requirements:
If you use the `--make-pr` or `-p` flag you'll need to install and configure git on your system as the go-git library does not support opening Pull Requests
If you use the `--make-pr` or `-p` flag you'll need to install and configure git on your system as the go-git library does not support opening Pull Requests.
You will need to install the GitHub CLI to create pull requests from the command line.
```shell
brew install gh
```

## Usage

Expand Down Expand Up @@ -135,6 +139,11 @@ This will result in the result object:
}
```

## Cloned repositories
Cloned repositories are stored in the `repository-mapper` folder in your home directory `~/repository-mapper` by default.
This directory will be created if it does not exist.
When you're done, you can go to this directory to delete the cloned repositories to save some disk space.

## Using All Repositories

If you need to simply get an up-to-date list of all active repositories in your org you can run the `get-all-repos`
Expand Down
2 changes: 1 addition & 1 deletion cmd/mapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ func validateArgs() error {
if makePr {
_, err := exec.LookPath("gh")
if err != nil {
return fmt.Errorf("The github cli is required to make a pull request. Please run:\nbrew install github/gh/gh")
return fmt.Errorf("The github cli is required to make a pull request. Please run:\nbrew install gh")
}
if title == "" {
return fmt.Errorf("A PR title is required. Pass one with -t")
Expand Down