Skip to content

Commit

Permalink
Rename executable from gitlab-helper-exe to gitlab-helper
Browse files Browse the repository at this point in the history
  • Loading branch information
L7R7 committed Jul 22, 2024
1 parent 9f2874f commit 33c450d
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 13 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ jobs:
- uses: actions/upload-artifact@v4
with:
name: gitlab-helper-exe
path: gitlab-helper-exe
name: gitlab-helper
path: gitlab-helper

markdown:
name: Markdown lint
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,11 @@ jobs:
- if: matrix.os == 'windows-latest'
name: Set binary path name on Windows
run: |
mv ./bin/gitlab-helper-exe.exe ./bin/gitlab-helper.exe
echo "BINARY_PATH=./bin/gitlab-helper.exe" >> $env:GITHUB_ENV
- if: matrix.os != 'windows-latest'
name: Set binary path name not on Windows
run: |
mv ./bin/gitlab-helper-exe ./bin/gitlab-helper
echo "BINARY_PATH=./bin/gitlab-helper" >> "$GITHUB_ENV"
- if: matrix.os != 'macOS-13'
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ target/
.hie/
tags
gitlab-helper-exe

gitlab-helper
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Let's say you have a bunch of projects that use Spring Boot, and there's a new v
You could list all of them like that:

```sh
gitlab-helper-exe update-merge-requests --user-id <user-id> --search "Spring Boot" list
gitlab-helper update-merge-requests --user-id <user-id> --search "Spring Boot" list
```

where `<user-id>` is the User ID of the bot user that your renovate-bot instance is using.
Expand All @@ -24,7 +24,7 @@ where `<user-id>` is the User ID of the bot user that your renovate-bot instance
If that looks good, you can merge them:

```sh
gitlab-helper-exe update-merge-requests --user-id <user-id> --search "Spring Boot" merge --execute
gitlab-helper update-merge-requests --user-id <user-id> --search "Spring Boot" merge --execute
```

The `--execute` flag actually makes the tool merge the merge requests. If you omit it, it will do a dry run (in this case, this would only list the MRs it would merge, equivalent to using `list`).
Expand All @@ -34,7 +34,7 @@ If there is no pipeline or the pipeline failed, the MR will stay open (consult t
If there is a bunch of other MRs open on the project (maybe because there was also an update to npm), you can rebase all of them in one go:

```sh
gitlab-helper-exe update-merge-requests --user-id <user-id> rebase --execute
gitlab-helper update-merge-requests --user-id <user-id> rebase --execute
```

After that, continue with the next bunch of similar MRs.
Expand Down Expand Up @@ -128,22 +128,22 @@ When you do that for the first time, it will take a while.
If you use `zsh`, put this in your `.zshrc` (see [here](https://stackoverflow.com/a/61861568/5247502)):

```shell script
gitlab-helper-exe --zsh-completion-script $(which gitlab-helper-exe) > ~/.config/zsh/completions/_gitlab-helper-exe
gitlab-helper --zsh-completion-script $(which gitlab-helper) > ~/.config/zsh/completions/_gitlab-helper
fpath=($HOME/.config/zsh/completions $fpath)
```

If that doesn't work or if you use `bash`:

```shell script
source <(gitlab-helper-exe --bash-completion-script `which gitlab-helper-exe`)
source <(gitlab-helper --bash-completion-script `which gitlab-helper`)
```

### Run

See what the tool can do for you:

```shell script
gitlab-helper-exe -h
gitlab-helper -h
```

The tool will start only if all properties are set in one of the sources.
Expand Down
2 changes: 1 addition & 1 deletion gitlab-helper.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ library
, yaml
default-language: Haskell2010

executable gitlab-helper-exe
executable gitlab-helper
main-is: Main.hs
other-modules:
Paths_gitlab_helper
Expand Down
2 changes: 1 addition & 1 deletion package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ library:
- yaml

executables:
gitlab-helper-exe:
gitlab-helper:
main: Main.hs
source-dirs: app
ghc-options:
Expand Down

0 comments on commit 33c450d

Please sign in to comment.