-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(breaking): drop Jsonnet support (#39)
- Loading branch information
1 parent
c76e8d3
commit 5d267f4
Showing
11 changed files
with
182 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # zit | ||
|
|
||
| _git identity manager_ | ||
|
|
||
| ## How it works | ||
|
|
||
| _zit_ chooses a git identity based on: | ||
|
|
||
| 1. git remote host | ||
| 2. repository owner | ||
| 3. repository name | ||
|
|
||
| … as defined in the configuration file: | ||
|
|
||
| ```yaml | ||
| {{.ExampleYaml}} | ||
| ``` | ||
|
|
||
| ## Setup | ||
|
|
||
| There are 2 ways to set up a configuration file: | ||
|
|
||
| 1. Place it at the default location: `$HOME/.zit/config.yaml` | ||
| 2. Specify an environment variable that points to the config file: | ||
|
|
||
| ```bash | ||
| export ZIT_CONFIG=/custom-location/.zit-config.yaml | ||
| ``` | ||
|
|
||
| If the environment variable is set up, it will be chosen over the config at the | ||
| default location. | ||
|
|
||
| ## Usage | ||
|
|
||
| To set up an identity, run `zit set` inside a repo directory: | ||
|
|
||
| ```bash | ||
| $ zit set # personal repo | ||
| set user: jdoe <jdoe@users.noreply.github.com> | ||
|
|
||
| $ git remote get-url origin | ||
| https://github.com/jdoe/repo.git | ||
| ``` | ||
|
|
||
| ```bash | ||
| $ zit set # work repo | ||
| set user: John Doe <john.doe@corp.com> | ||
|
|
||
| $ git remote get-url origin | ||
| git@github.corp.com:team/repo.git | ||
| ``` | ||
|
|
||
| **Note**: Use `--dry-run` flag to test which identity will be used without | ||
| applying it. | ||
|
|
||
| ## Installation | ||
|
|
||
| **On Mac/Linux with Homebrew** | ||
|
|
||
| ```bash | ||
| brew tap ayakovlenko/tools | ||
| brew install ayakovlenko/tools/zit | ||
| ``` | ||
|
|
||
| **From sources** | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ayakovlenko/zit.git | ||
| cd zit | ||
| go install | ||
| ``` | ||
|
|
||
| **From binaries** | ||
|
|
||
| Download binaries from the | ||
| [releases](https://github.com/ayakovlenko/zit/releases) page. | ||
|
|
||
| ## Setup | ||
|
|
||
| **Remove any existing global identity** | ||
|
|
||
| ```bash | ||
| git config --unset-all --global user.name | ||
| git config --unset-all --global user.email | ||
| git config --unset-all --system user.name | ||
| git config --unset-all --system user.email | ||
| ``` | ||
|
|
||
| **Require config to exist in order to make commits** | ||
|
|
||
| ```bash | ||
| git config --global user.useConfigOnly true | ||
| ``` | ||
|
|
||
| Without the global user name and user email, git would use the system's hostname | ||
| and username to make commits. Tell git to throw an error instead, requiring you | ||
| to specify an identity for every new project. | ||
|
|
||
| Run `zit doctor` to make sure the system is configured correctly: | ||
|
|
||
| ```bash | ||
| $ zit doctor | ||
| - [x] git config --global user.useConfigOnly true | ||
| - [x] git config --unset-all --global user.name | ||
| - [x] git config --unset-all --global user.email | ||
| - [x] git config --unset-all --system user.name | ||
| - [x] git config --unset-all --system user.email | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| users: | ||
| work: &work_user | ||
| name: "John Doe" | ||
| email: "john.doe@corp.com" | ||
| personal: | ||
| github_user: &personal_github_user | ||
| name: "JD42" | ||
| email: "JD42@users.noreply.github.com" | ||
| gitlab_user: &personal_gitlab_user | ||
| name: "JD42" | ||
| email: "786972-JD42@users.noreply.gitlab.com" | ||
|
|
||
| hosts: | ||
| github.com: | ||
| default: *personal_github_user | ||
| overrides: | ||
| - owner: "corp" | ||
| user: *work_user | ||
| gitlab.com: | ||
| default: *personal_gitlab_user |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.