Skip to content

Commit

Permalink
docs: Update README to clarify the flow
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanilves committed Nov 3, 2022
1 parent 9be7e69 commit 4e6b33a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 22 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ check-git-branch:
then echo "ERR: Need to be on the \"${GIT_BRANCH}\" branch" >>/dev/stderr; \
exit 1; fi

pull-git-branch:
git pull

next-version-tag:
git tag ${NEXT_VERSION} && git push --tags

release: check-git-branch next-version-tag
release: check-git-branch pull-git-branch next-version-tag
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ Core feature of this program is the ability to change working directory while st
This **can not** be done by the program itself, because of `POSIX` security limitations. Without instrumenting
the shell with aliases `travelgrunt` will not work!

## How to install?
## How to install? :neckbeard:

### Install with homebrew
### Install with `homebrew`:

```
brew tap ivanilves/tap
brew install ivanilves/tap/travelgrunt
```

### Install latest binary with cURL
### Install latest binary with `cURL` + `sh`:
Install latest release binary into `/usr/local/bin` (default):

```
Expand All @@ -47,10 +47,19 @@ curl -s -f \
| PREFIX=/somewhere/else sh
```

## How to build?
## How to build? :construction:

* `make dep` - install/ensure dependencies;
* `make build` - build the `travelgrunt` binary in `cmd/travelgrunt` path;
* `make install` - [optional] install built `travelgrunt` binary under the `${PREFIX}/bin` location;

[How to release a new version?](RELEASE.md) :package:
## How to release a new version? :package:

:bulb: Make sure you have push permissions for this repository!

Run `make release` recipe, which will:
* check, if you are on a `main` branch;
* pull the latest `main` branch from remote;
* calculate the next release version (update `MAJOR`.`MINOR` [here](https://github.com/ivanilves/travelgrunt/blob/main/Makefile#L2) if needed);
* tag the branch tip with the version calculated and push tag to remote then;
* [GoReleaser](https://github.com/ivanilves/travelgrunt/blob/main/.goreleaser.yml) will take care of everything else :sunglasses:
16 changes: 0 additions & 16 deletions RELEASE.md

This file was deleted.

0 comments on commit 4e6b33a

Please sign in to comment.