Skip to content

Commit 826d18b

Browse files
Chore: Update stale URL references and add documentation around releases (#326)
* chore: change URL references to old repo * update README.md
1 parent 249e9ad commit 826d18b

14 files changed

+354
-354
lines changed

CHANGELOG.md

+308-308
Large diffs are not rendered by default.

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Contributing
1+
# Contributing
22

3-
The goenv source code is [hosted on GitHub](https://github.com/syndbg/goenv).
3+
The goenv source code is [hosted on GitHub](https://github.com/go-nv/goenv).
44
It's clean, modular, and easy to understand, even if you're not a shell hacker. (I hope)
55

66
Tests are executed using [Bats](https://github.com/bats-core/bats-core).
77

8-
Please feel free to submit pull requests and file bugs on the [issue tracker](https://github.com/syndbg/goenv/issues).
8+
Please feel free to submit pull requests and file bugs on the [issue tracker](https://github.com/go-nv/goenv/issues).
99

1010
## Prerequisites
1111

12-
* Linux with any (or more than 1) of `zsh`, `bash`, `zsh`.
12+
- Linux with any (or more than 1) of `zsh`, `bash`, `zsh`.
1313

1414
## Common commands
1515

@@ -40,22 +40,22 @@ Check the [Makefile](./Makefile)
4040
### Submitting an issue
4141

4242
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.
43+
If it is, it's highly recommended to add to that issue with your reports.
4444
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.
45+
3. Be as detailed as possible - Linux distribution, shell, what did you do,
46+
what did you expect to happen, what actually happened.
4747

4848
### Submitting a PR
4949

5050
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.
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.
5353
1. Branch out from latest `master`.
5454
1. Code, add, commit and push your changes in your branch.
5555
1. Make sure that tests (or let the CI do the heavy work for you).
5656
1. Submit a PR.
5757
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.
58+
A simple `[WIP]` (in any form) is a good indicator whether the PR is still being actively developed.
5959
1. Collaborate with the codeowners/reviewers to merge this in `master`.
6060

6161
### Release process

ENVIRONMENT_VARIABLES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ name | default | description
1010
`GOENV_HOOK_PATH` | | Colon-separated list of paths searched for goenv hooks.
1111
`GOENV_DIR` | `$PWD` | Directory to start searching for `.go-version` files.
1212
`GOENV_DISABLE_GOROOT` | `0` | Disables management of `GOROOT`.<br> Set this to `1` if you want to use a `GOROOT` that you export.
13-
`GOENV_DISABLE_GOPATH` | `0` | Disables management of `GOPATH`.<br> Set this to `1` if you want to use a `GOPATH` that you export. It's recommend that you use this (as set to `0`) 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
13+
`GOENV_DISABLE_GOPATH` | `0` | Disables management of `GOPATH`.<br> Set this to `1` if you want to use a `GOPATH` that you export. It's recommend that you use this (as set to `0`) to avoid mixing multiple versions of golang packages at `GOPATH` when using different versions of golang. See https://github.com/go-nv/goenv/issues/72#issuecomment-478011438
1414
`GOENV_GOPATH_PREFIX` | `$HOME/go` | `GOPATH` prefix that's exported when `GOENV_DISABLE_GOPATH` is not `1`.<br> E.g in practice it can be `$HOME/go/1.12.0` if you currently use `1.12.0` version of go.
1515
`GOENV_APPEND_GOPATH` | | If `GOPATH` is set, it will be appended to the computed `GOPATH`.
1616
`GOENV_PREPEND_GOPATH` | | If `GOPATH` is set, it will be prepended to the computed `GOPATH`.

HOW_IT_WORKS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,19 @@ When you execute a shim, goenv determines which Go version to use by
4646
reading it from the following sources, in this order:
4747

4848
1. The `GOENV_VERSION` environment variable (if specified). You can use
49-
the [`goenv shell`](https://github.com/syndbg/goenv/blob/master/COMMANDS.md#goenv-shell) command to set this environment
49+
the [`goenv shell`](https://github.com/go-nv/goenv/blob/master/COMMANDS.md#goenv-shell) command to set this environment
5050
variable in your current shell session.
5151

5252
2. The application-specific `.go-version` file in the current
5353
directory (if present). You can modify the current directory's
54-
`.go-version` file with the [`goenv local`](https://github.com/syndbg/goenv/blob/master/COMMANDS.md#goenv-local)
54+
`.go-version` file with the [`goenv local`](https://github.com/go-nv/goenv/blob/master/COMMANDS.md#goenv-local)
5555
command.
5656

5757
3. The first `.go-version` file found (if any) by searching each parent
5858
directory, until reaching the root of your filesystem.
5959

6060
4. The global `~/.goenv/version` file. You can modify this file using
61-
the [`goenv global`](https://github.com/syndbg/goenv/blob/master/COMMANDS.md#goenv-global) command. If the global version
61+
the [`goenv global`](https://github.com/go-nv/goenv/blob/master/COMMANDS.md#goenv-global) command. If the global version
6262
file is not present, goenv assumes you want to use the "system"
6363
Go. (In other words, whatever version would run if goenv isn't present in
6464
`PATH`.)

INSTALL.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ easy to fork and contribute any changes back upstream.
88
1. **Check out goenv where you want it installed.**
99
A good place to choose is `$HOME/.goenv` (but you can install it somewhere else).
1010

11-
git clone https://github.com/syndbg/goenv.git ~/.goenv
11+
git clone https://github.com/go-nv/goenv.git ~/.goenv
1212

1313
2. **Define environment variable `GOENV_ROOT`** to point to the path where
1414
goenv repo is cloned and add `$GOENV_ROOT/bin` to your `$PATH` for access
@@ -55,7 +55,7 @@ easy to fork and contribute any changes back upstream.
5555

5656
**Security warning**: You likely want to keep $GOPATH/bin at the end
5757
of your $PATH as shown above, rather than at the beginning. See
58-
[#99](https://github.com/syndbg/goenv/issues/99) for details and
58+
[#99](https://github.com/go-nv/goenv/issues/99) for details and
5959
discussion.
6060

6161

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Go Version Management: goenv
22

3-
[![PR Checks Status](https://github.com/syndbg/goenv/actions/workflows/pr_checks.yml/badge.svg)](https://github.com/syndbg/goenv/actions/workflows/pr_checks.yml)
3+
[![PR Checks Status](https://github.com/go-nv/goenv/actions/workflows/pr_checks.yml/badge.svg)](https://github.com/go-nv/goenv/actions/workflows/pr_checks.yml)
44

55
goenv aims to be as simple as possible and follow the already established
66
successful version management model of [pyenv](https://github.com/yyuu/pyenv) and [rbenv](https://github.com/rbenv/rbenv).
77

8+
New go versions are added automatically on a daily CRON schedule.
9+
810
This project was cloned from [pyenv](https://github.com/yyuu/pyenv) and modified for Go.
911

1012
[![asciicast](https://asciinema.org/a/17IT3YiQ56hiJsb2iHpGHlJqj.svg)](https://asciinema.org/a/17IT3YiQ56hiJsb2iHpGHlJqj)

RELEASE_PROCESS.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# Release process
22

3-
Releases are done **manually**.
4-
5-
Automation may be introduced, but currently they're not that much of an issue.
3+
Releases are done **automatically** via GitHub actions and Release Drafter.
64

75
## Rules
86

97
1. Releases are only created from `master`.
108
1. `master` is meant to be stable, so before tagging and create a new release, make sure that the CI checks pass.
119
1. Releases are GitHub releases.
1210
1. Releases are following *semantic versioning*.
13-
1. Releases are to be named in pattern of `vX.Y.Z`. The produced binary artifacts contain the `vX.Y.Z` in their names.
11+
1. Releases are to be named in pattern of `X.Y.Z`. The produced binary artifacts contain the `X.Y.Z` in their names.
1412
1. Changelog must up-to-date with what's going to be released. Check [CHANGELOG](./CHANGELOG.md).
1513
1. **Make sure** to bump the version of `goenv`. Bumping the version of `go-build` is often omitted.
1614

1715
## Flow
1816

19-
1. Create a new GitHub release using https://github.com/syndbg/goenv
17+
1. Create a new GitHub release using https://github.com/go-nv/goenv
2018
1. `Tag Version` and `Release Title` are going to be in pattern of `vX.Y.Z`.
2119
1. `Describe this release` (content) is going to link the appropriate [CHANGELOG](./CHANGELOG.md) entry.

libexec/goenv-help

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ if [ -z "$1" ] || [ "$1" == "goenv" ]; then
152152
print_summaries commands local global shell install uninstall rehash version versions which whence
153153
echo
154154
echo "See 'goenv help <command>' for information on a specific command."
155-
echo "For full documentation, see: https://github.com/syndbg/goenv#readme"
155+
echo "For full documentation, see: https://github.com/go-nv/goenv#readme"
156156
else
157157
command="$1"
158158
if [ -n "$(command_path "$command")" ]; then

plugins/go-build/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# go-build
22

3-
go-build is a [goenv](https://github.com/syndbg/goenv) plugin that
3+
go-build is a [goenv](https://github.com/go-nv/goenv) plugin that
44
provides a `goenv install` command to compile and install different versions
55
of Go on UNIX-like systems.
66

77
You can also use go-build without goenv in environments where you need
88
precise control over Go version installation.
99

10-
See the [list of releases](https://github.com/syndbg/goenv/releases)
10+
See the [list of releases](https://github.com/go-nv/goenv/releases)
1111
for changes in each version.
1212

1313

@@ -54,7 +54,7 @@ Or, if you would like to install the latest development release:
5454
## Usage
5555

5656
Before you begin, you should ensure that your build environment has the proper
57-
system dependencies for compiling the wanted Go Version (see our [recommendations](https://github.com/syndbg/goenv/wiki#suggested-build-environment)).
57+
system dependencies for compiling the wanted Go Version (see our [recommendations](https://github.com/go-nv/goenv/wiki#suggested-build-environment)).
5858

5959
### Using `goenv install` with goenv
6060

@@ -92,10 +92,10 @@ Both `goenv install` and `go-build` accept a path to a custom definition file
9292
in place of a version name. Custom definitions let you develop and install
9393
versions of Golang that are not yet supported by go-build.
9494

95-
See the [go-build built-in definitions](https://github.com/syndbg/goenv/tree/master/plugins/go-build/share/go-build) as a starting point for
95+
See the [go-build built-in definitions](https://github.com/go-nv/goenv/tree/master/plugins/go-build/share/go-build) as a starting point for
9696
custom definition files.
9797

98-
[definitions]: https://github.com/syndbg/goenv/tree/master/plugins/go-build/share/go-build
98+
[definitions]: https://github.com/go-nv/goenv/tree/master/plugins/go-build/share/go-build
9999

100100
### Special environment variables
101101

@@ -194,5 +194,5 @@ variable when using `--keep` with `go-build`.
194194
## Getting Help
195195

196196
If you can't find an answer on the, open an issue on the [issue
197-
tracker](https://github.com/syndbg/goenv/issues). Be sure to include
197+
tracker](https://github.com/go-nv/goenv/issues). Be sure to include
198198
the full build log for build failures.

plugins/go-build/bin/go-build

+1-1
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ verify_go() {
722722
echo
723723
echo "The go-build could not find proper executable of Go after successful build."
724724
echo "Please open an issue for future improvements."
725-
echo "https://github.com/syndbg/goenv/issues"
725+
echo "https://github.com/go-nv/goenv/issues"
726726
return 1
727727
} >&3
728728
fi

plugins/go-build/bin/goenv-install

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#
2323
# For detailed information on installing Go versions with
2424
# go-build, including a list of environment variables for adjusting
25-
# compilation, see: https://github.com/syndbg/goenv#readme
25+
# compilation, see: https://github.com/go-nv/goenv#readme
2626
#
2727
set -e
2828
[ -n "$GOENV_DEBUG" ] && set -x

plugins/go-build/test/goenv-install.bats

+7-7
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
5858
5959
For detailed information on installing Go versions with
6060
go-build, including a list of environment variables for adjusting
61-
compilation, see: https://github.com/syndbg/goenv#readme
61+
compilation, see: https://github.com/go-nv/goenv#readme
6262
OUT
6363
}
6464

@@ -86,7 +86,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
8686
8787
For detailed information on installing Go versions with
8888
go-build, including a list of environment variables for adjusting
89-
compilation, see: https://github.com/syndbg/goenv#readme
89+
compilation, see: https://github.com/go-nv/goenv#readme
9090
OUT
9191
}
9292

@@ -114,7 +114,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
114114
115115
For detailed information on installing Go versions with
116116
go-build, including a list of environment variables for adjusting
117-
compilation, see: https://github.com/syndbg/goenv#readme
117+
compilation, see: https://github.com/go-nv/goenv#readme
118118
OUT
119119
}
120120

@@ -142,7 +142,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
142142
143143
For detailed information on installing Go versions with
144144
go-build, including a list of environment variables for adjusting
145-
compilation, see: https://github.com/syndbg/goenv#readme
145+
compilation, see: https://github.com/go-nv/goenv#readme
146146
OUT
147147
}
148148

@@ -170,7 +170,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
170170
171171
For detailed information on installing Go versions with
172172
go-build, including a list of environment variables for adjusting
173-
compilation, see: https://github.com/syndbg/goenv#readme
173+
compilation, see: https://github.com/go-nv/goenv#readme
174174
OUT
175175
}
176176

@@ -198,7 +198,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
198198
199199
For detailed information on installing Go versions with
200200
go-build, including a list of environment variables for adjusting
201-
compilation, see: https://github.com/syndbg/goenv#readme
201+
compilation, see: https://github.com/go-nv/goenv#readme
202202
OUT
203203
}
204204

@@ -226,7 +226,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
226226
227227
For detailed information on installing Go versions with
228228
go-build, including a list of environment variables for adjusting
229-
compilation, see: https://github.com/syndbg/goenv#readme
229+
compilation, see: https://github.com/go-nv/goenv#readme
230230
OUT
231231
}
232232

test/goenv-help.bats

+6-6
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Some useful goenv commands are:
2727
whence List all Go versions that contain the given executable
2828
2929
See 'goenv help <command>' for information on a specific command.
30-
For full documentation, see: https://github.com/syndbg/goenv#readme
30+
For full documentation, see: https://github.com/go-nv/goenv#readme
3131
OUT
3232
}
3333

@@ -38,7 +38,7 @@ OUT
3838

3939
@test "shows help for a specific command that exists" {
4040
mkdir -p "${GOENV_TEST_DIR}/bin"
41-
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
41+
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
4242
#!shebang
4343
# Usage: goenv hello <world>
4444
# Summary: Says "hello" to you, from goenv
@@ -57,7 +57,7 @@ SH
5757

5858
@test "replaces missing extended help with summary text for a specific command that exists" {
5959
mkdir -p "${GOENV_TEST_DIR}/bin"
60-
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
60+
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
6161
#!shebang
6262
# Usage: goenv hello <world>
6363
# Summary: Says "hello" to you, from goenv
@@ -75,7 +75,7 @@ SH
7575

7676
@test "extracts only usage when '--usage' for a specific command that exists" {
7777
mkdir -p "${GOENV_TEST_DIR}/bin"
78-
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
78+
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
7979
#!shebang
8080
# Usage: goenv hello <world>
8181
# Summary: Says "hello" to you, from goenv
@@ -89,7 +89,7 @@ SH
8989

9090
@test "multiline usage section is returned when '--usage' for a specific command that exists" {
9191
mkdir -p "${GOENV_TEST_DIR}/bin"
92-
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
92+
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
9393
#!shebang
9494
# Usage: goenv hello <world>
9595
# goenv hi [everybody]
@@ -112,7 +112,7 @@ SH
112112

113113
@test "multiline extended help section is returned for a specific command that exists" {
114114
mkdir -p "${GOENV_TEST_DIR}/bin"
115-
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
115+
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
116116
#!shebang
117117
# Usage: goenv hello <world>
118118
# Summary: Says "hello" to you, from goenv

test/goenv.bats

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Some useful goenv commands are:
2323
whence List all Go versions that contain the given executable
2424
2525
See 'goenv help <command>' for information on a specific command.
26-
For full documentation, see: https://github.com/syndbg/goenv#readme
26+
For full documentation, see: https://github.com/go-nv/goenv#readme
2727
OUT
2828
}
2929

@@ -100,7 +100,7 @@ OUT
100100
assert_success "${GOENV_ROOT}/goenv.d:${BATS_TEST_DIRNAME%/*}/goenv.d:/usr/local/etc/goenv.d:/etc/goenv.d:/usr/lib/goenv/hooks"
101101
}
102102

103-
@test "prints error when called with 'shell' subcommand, but `GOENV_SHELL` environment variable is not present" {
103+
@test "prints error when called with 'shell' subcommand, but $(GOENV_SHELL) environment variable is not present" {
104104
unset GOENV_SHELL
105105
run goenv shell
106106
assert_output <<'OUT'

0 commit comments

Comments
 (0)