Skip to content

Commit

Permalink
Chore: Update stale URL references and add documentation around relea…
Browse files Browse the repository at this point in the history
…ses (#326)

* chore: change URL references to old repo

* update README.md
  • Loading branch information
ChronosMasterOfAllTime authored Jul 27, 2023
1 parent 249e9ad commit 826d18b
Show file tree
Hide file tree
Showing 14 changed files with 354 additions and 354 deletions.
616 changes: 308 additions & 308 deletions CHANGELOG.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Contributing
# Contributing

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

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

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

## Prerequisites

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

## Common commands

Expand Down Expand Up @@ -40,22 +40,22 @@ Check the [Makefile](./Makefile)
### Submitting an issue

1. Check existing issues and verify that your issue is not already submitted.
If it is, it's highly recommended to add to that issue with your reports.
If it is, it's highly recommended to add to that issue with your reports.
2. Open issue
3. Be as detailed as possible - Linux distribution, shell, what did you do,
what did you expect to happen, what actually happened.
3. Be as detailed as possible - Linux distribution, shell, what did you do,
what did you expect to happen, what actually happened.

### Submitting a PR

1. Find an existing issue to work on or follow `Submitting an issue` to create one
that you're also going to fix.
Make sure to notify that you're working on a fix for the issue you picked.
that you're also going to fix.
Make sure to notify that you're working on a fix for the issue you picked.
1. Branch out from latest `master`.
1. Code, add, commit and push your changes in your branch.
1. Make sure that tests (or let the CI do the heavy work for you).
1. Submit a PR.
1. Make sure to clarify if the PR is ready for review or work-in-progress.
A simple `[WIP]` (in any form) is a good indicator whether the PR is still being actively developed.
A simple `[WIP]` (in any form) is a good indicator whether the PR is still being actively developed.
1. Collaborate with the codeowners/reviewers to merge this in `master`.

### Release process
Expand Down
2 changes: 1 addition & 1 deletion ENVIRONMENT_VARIABLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ name | default | description
`GOENV_HOOK_PATH` | | Colon-separated list of paths searched for goenv hooks.
`GOENV_DIR` | `$PWD` | Directory to start searching for `.go-version` files.
`GOENV_DISABLE_GOROOT` | `0` | Disables management of `GOROOT`.<br> Set this to `1` if you want to use a `GOROOT` that you export.
`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
`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
`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.
`GOENV_APPEND_GOPATH` | | If `GOPATH` is set, it will be appended to the computed `GOPATH`.
`GOENV_PREPEND_GOPATH` | | If `GOPATH` is set, it will be prepended to the computed `GOPATH`.
Expand Down
6 changes: 3 additions & 3 deletions HOW_IT_WORKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,19 @@ When you execute a shim, goenv determines which Go version to use by
reading it from the following sources, in this order:

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

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

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

4. The global `~/.goenv/version` file. You can modify this file using
the [`goenv global`](https://github.com/syndbg/goenv/blob/master/COMMANDS.md#goenv-global) command. If the global version
the [`goenv global`](https://github.com/go-nv/goenv/blob/master/COMMANDS.md#goenv-global) command. If the global version
file is not present, goenv assumes you want to use the "system"
Go. (In other words, whatever version would run if goenv isn't present in
`PATH`.)
Expand Down
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ easy to fork and contribute any changes back upstream.
1. **Check out goenv where you want it installed.**
A good place to choose is `$HOME/.goenv` (but you can install it somewhere else).

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

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

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


Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Go Version Management: goenv

[![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)
[![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)

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

New go versions are added automatically on a daily CRON schedule.

This project was cloned from [pyenv](https://github.com/yyuu/pyenv) and modified for Go.

[![asciicast](https://asciinema.org/a/17IT3YiQ56hiJsb2iHpGHlJqj.svg)](https://asciinema.org/a/17IT3YiQ56hiJsb2iHpGHlJqj)
Expand Down
8 changes: 3 additions & 5 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# Release process

Releases are done **manually**.

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

## Rules

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

## Flow

1. Create a new GitHub release using https://github.com/syndbg/goenv
1. Create a new GitHub release using https://github.com/go-nv/goenv
1. `Tag Version` and `Release Title` are going to be in pattern of `vX.Y.Z`.
1. `Describe this release` (content) is going to link the appropriate [CHANGELOG](./CHANGELOG.md) entry.
2 changes: 1 addition & 1 deletion libexec/goenv-help
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ if [ -z "$1" ] || [ "$1" == "goenv" ]; then
print_summaries commands local global shell install uninstall rehash version versions which whence
echo
echo "See 'goenv help <command>' for information on a specific command."
echo "For full documentation, see: https://github.com/syndbg/goenv#readme"
echo "For full documentation, see: https://github.com/go-nv/goenv#readme"
else
command="$1"
if [ -n "$(command_path "$command")" ]; then
Expand Down
12 changes: 6 additions & 6 deletions plugins/go-build/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# go-build

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

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

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


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

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

### Using `goenv install` with goenv

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

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
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
custom definition files.

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

### Special environment variables

Expand Down Expand Up @@ -194,5 +194,5 @@ variable when using `--keep` with `go-build`.
## Getting Help

If you can't find an answer on the, open an issue on the [issue
tracker](https://github.com/syndbg/goenv/issues). Be sure to include
tracker](https://github.com/go-nv/goenv/issues). Be sure to include
the full build log for build failures.
2 changes: 1 addition & 1 deletion plugins/go-build/bin/go-build
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,7 @@ verify_go() {
echo
echo "The go-build could not find proper executable of Go after successful build."
echo "Please open an issue for future improvements."
echo "https://github.com/syndbg/goenv/issues"
echo "https://github.com/go-nv/goenv/issues"
return 1
} >&3
fi
Expand Down
2 changes: 1 addition & 1 deletion plugins/go-build/bin/goenv-install
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#
# For detailed information on installing Go versions with
# go-build, including a list of environment variables for adjusting
# compilation, see: https://github.com/syndbg/goenv#readme
# compilation, see: https://github.com/go-nv/goenv#readme
#
set -e
[ -n "$GOENV_DEBUG" ] && set -x
Expand Down
14 changes: 7 additions & 7 deletions plugins/go-build/test/goenv-install.bats
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Usage: goenv install [-f] [-kvp] <version>|latest|unstable
For detailed information on installing Go versions with
go-build, including a list of environment variables for adjusting
compilation, see: https://github.com/syndbg/goenv#readme
compilation, see: https://github.com/go-nv/goenv#readme
OUT
}

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

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

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

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

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

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

Expand Down
12 changes: 6 additions & 6 deletions test/goenv-help.bats
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Some useful goenv commands are:
whence List all Go versions that contain the given executable
See 'goenv help <command>' for information on a specific command.
For full documentation, see: https://github.com/syndbg/goenv#readme
For full documentation, see: https://github.com/go-nv/goenv#readme
OUT
}

Expand All @@ -38,7 +38,7 @@ OUT

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

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

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

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

@test "multiline extended help section is returned for a specific command that exists" {
mkdir -p "${GOENV_TEST_DIR}/bin"
cat > "${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
cat >"${GOENV_TEST_DIR}/bin/goenv-hello" <<SH
#!shebang
# Usage: goenv hello <world>
# Summary: Says "hello" to you, from goenv
Expand Down
4 changes: 2 additions & 2 deletions test/goenv.bats
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Some useful goenv commands are:
whence List all Go versions that contain the given executable
See 'goenv help <command>' for information on a specific command.
For full documentation, see: https://github.com/syndbg/goenv#readme
For full documentation, see: https://github.com/go-nv/goenv#readme
OUT
}

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

@test "prints error when called with 'shell' subcommand, but `GOENV_SHELL` environment variable is not present" {
@test "prints error when called with 'shell' subcommand, but $(GOENV_SHELL) environment variable is not present" {
unset GOENV_SHELL
run goenv shell
assert_output <<'OUT'
Expand Down

0 comments on commit 826d18b

Please sign in to comment.