Skip to content

Commit 55e3b74

Browse files
syndbgsyndbg
authored
Merge pull request #74 from syndbg/prepare-2.0.0beta8
Prepare 2.0.0beta8
2 parents d0b8429 + f3ea934 commit 55e3b74

6 files changed

Lines changed: 98 additions & 34 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,28 @@ Introducing breaking changes under a feature flag can be ok in some cases where
4545

4646
## Changelog
4747

48+
Change line format:
49+
50+
```
51+
* <Change title/PR title/content> ; Ref: <pr link>
52+
```
53+
4854
## Unreleased (master)
4955

56+
## 2.0.0beta8
57+
58+
### Added
59+
60+
* Add golang installations of 1.12.2, 1.12.3, 1.11.7 and 1.11.8 ; Ref: https://github.com/syndbg/goenv/pull/73
61+
62+
### Fixed
63+
64+
* Lack of environment variables configuration documentation after https://github.com/syndbg/goenv/pull/70.
65+
Also fixed lack of Contributing guidelines ; Ref https://github.com/syndbg/goenv/pull/74
66+
5067
## 2.0.0beta7
5168

52-
#### Added
69+
### Added
5370

5471
* Add golang installations of 1.12.1. and 1.11.6 ; Ref: https://github.com/syndbg/goenv/pull/71
5572

‎CONTRIBUTING.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing
2+
3+
The goenv source code is [hosted on GitHub](https://github.com/syndbg/goenv).
4+
It's clean, modular, and easy to understand, even if you're not a shell hacker. (I hope)
5+
6+
Tests are executed using [Bats](https://github.com/bats-core/bats-core).
7+
8+
Please feel free to submit pull requests and file bugs on the [issue tracker](https://github.com/syndbg/goenv/issues).
9+
10+
## Prerequisites
11+
12+
* Linux with any (or more than 1) of `zsh`, `bash`, `zsh`.
13+
14+
## Common commands
15+
16+
### Running the tests for both `goenv` and `goenv-go-build`
17+
18+
```shell
19+
> make test
20+
```
21+
22+
### Running the tests only for `goenv`
23+
24+
```shell
25+
> make test-goenv
26+
```
27+
28+
### Running the tests only for `goenv-go-build`
29+
30+
```shell
31+
> make test-goenv-go-build
32+
```
33+
34+
### Others
35+
36+
Check the [Makefile](./Makefile)
37+
38+
## Workflows
39+
40+
### Submitting an issue
41+
42+
1. Check existing issues and verify that your issue is not already submitted.
43+
If it is, it's highly recommended to add to that issue with your reports.
44+
2. Open issue
45+
3. Be as detailed as possible - Linux distribution, shell, what did you do,
46+
what did you expect to happen, what actually happened.
47+
48+
### Submitting a PR
49+
50+
1. Find an existing issue to work on or follow `Submitting an issue` to create one
51+
that you're also going to fix.
52+
Make sure to notify that you're working on a fix for the issue you picked.
53+
1. Branch out from latest `master`.
54+
1. Code, add, commit and push your changes in your branch.
55+
1. Make sure that tests (or let the CI do the heavy work for you).
56+
1. Submit a PR.
57+
1. Make sure to clarify if the PR is ready for review or work-in-progress.
58+
A simple `[WIP]` (in any form) is a good indicator whether the PR is still being actively developed.
59+
1. Collaborate with the codeowners/reviewers to merge this in `master`.

‎ENVIRONMENT_VARIABLES.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Environment variables
2+
3+
You can configure how `goenv` operates with the following settings:
4+
5+
name | default | description
6+
-----|---------|------------
7+
`GOENV_VERSION` | | Specifies the Go version to be used.<br>Also see `goenv help shell`.
8+
`GOENV_ROOT` | `~/.goenv` | Defines the directory under which Go versions and shims reside.<br> Current value shown by `goenv root`.
9+
`GOENV_DEBUG` | | Outputs debug information.<br>Also as: `goenv --debug <subcommand>`
10+
`GOENV_HOOK_PATH` | | Colon-separated list of paths searched for goenv hooks.
11+
`GOENV_DIR` | `$PWD` | Directory to start searching for `.go-version` files.
12+
`GOENV_DISABLE_GOROOT` | `false` | Disables management of `GOROOT`.<br> Set this to `true` if you want to use a `GOROOT` that you export.
13+
`GOENV_DISABLE_GOPATH` | `false` | Disables management of `GOPATH`.<br> Set this to `true` if you want to use a `GOPATH` that you export. It's recommend that you use this (as set to `false`) to avoid mixing multiple versions of golang packages at `GOPATH` when using different versions of golang. See https://github.com/syndbg/goenv/issues/72#issuecomment-478011438
14+
`GOENV_GOPATH_PREFIX` | `$HOME/go` | `GOPATH` prefix that's exported when `GOENV_DISABLE_GOPATH` is not `true`.<br> E.g in practice it can be `$HOME/go/1.12.0` if you currently use `1.12.0` version of go.

‎README.md‎

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ This project was cloned from [pyenv](https://github.com/yyuu/pyenv) and modified
2121

2222
* https://github.com/pwoolcoc/goenv depends on Python,
2323
* https://github.com/crsmithdev/goenv depends on Go,
24-
* https://github.com/moovweb/gvm is a different approach of the problem that's modeled after `nvm`. `goenv` is more simplified.
24+
* https://github.com/moovweb/gvm is a different approach to the problem that's modeled after `nvm`.
25+
`goenv` is more simplified.
2526

2627
----
2728

@@ -30,34 +31,7 @@ This project was cloned from [pyenv](https://github.com/yyuu/pyenv) and modified
3031
* **[How It Works](./HOW_IT_WORKS.md)**
3132
* **[Installation](./INSTALL.md)**
3233
* **[Command Reference](./COMMANDS.md)**
33-
* **[Environment variables](#environment-variables)**
34-
* **[Development](#development)**
34+
* **[Environment variables](./ENVIRONMENT_VARIABLES.md)**
35+
* **[Contributing](./CONTRIBUTING.md)**
36+
* **[Code-of-Conduct](./CODE_OF_CONDUCT.md)**
3537

36-
----
37-
38-
## Environment variables
39-
40-
You can affect how goenv operates with the following settings:
41-
42-
name | default | description
43-
-----|---------|------------
44-
`GOENV_VERSION` | | Specifies the Go version to be used.<br>Also see `goenv help shell`.
45-
`GOENV_ROOT` | `~/.goenv` | Defines the directory under which Go versions and shims reside.<br> Current value shown by `goenv root`.
46-
`GOENV_DEBUG` | | Outputs debug information.<br>Also as: `goenv --debug <subcommand>`
47-
`GOENV_HOOK_PATH` | | Colon-separated list of paths searched for goenv hooks.
48-
`GOENV_DIR` | `$PWD` | Directory to start searching for `.go-version` files.
49-
50-
## Development
51-
52-
The goenv source code is [hosted on
53-
GitHub](https://github.com/syndbg/goenv). It's clean, modular,
54-
and easy to understand, even if you're not a shell hacker. (I hope)
55-
56-
Tests are executed using [Bats](https://github.com/bats-core/bats-core):
57-
58-
```
59-
$ make test
60-
```
61-
62-
Please feel free to submit pull requests and file bugs on the [issue
63-
tracker](https://github.com/syndbg/goenv/issues).

‎libexec/goenv---version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
set -e
77
[ -n "$GOENV_DEBUG" ] && set -x
88

9-
version="2.0.0beta7"
9+
version="2.0.0beta8"
1010

1111
echo "goenv ${version}"

‎test/goenv--version.bats‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
load test_helper
44

5-
expected_version="goenv 2.0.0beta7"
5+
expected_version="goenv 2.0.0beta8"
66

77
@test "default version is 'version' variable" {
88
assert [ ! -e "$GOENV_ROOT" ]

0 commit comments

Comments
 (0)