Skip to content

Commit

Permalink
fix: update install instructions for PowerShell (#124)
Browse files Browse the repository at this point in the history
* fix: correct a few errors in comments

* fix: add powershell install script to release-please update list

* fix: correct the PS install instructions
  • Loading branch information
coffeebeats authored Nov 2, 2023
1 parent 96d07f6 commit 9fa6007
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ jobs:

extra-files: |
cmd/gdenv/main.go
scripts/install.ps1
scripts/install.sh
publish:
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ gdenv pin -i --path /path/to/project 4.0

The easiest way to install `gdenv` is by using the pre-built binaries. These can be manually downloaded and configured, but automated installation scripts are provided and recommended.

See the full [installation instructions](./docs/installation.md) for additional options for installing `gdenv`.
See the full [installation instructions](./docs/installation.md) for additional options when installing `gdenv`.

> ⚠️ **WARNING:** It's good practice to inspect an installation script prior to execution. The scripts are included in this repository and can be reviewed prior to use.
Expand Down Expand Up @@ -56,7 +56,8 @@ Invoke-WebRequest `
-UseBasicParsing `
-Uri "https://raw.githubusercontent.com/coffeebeats/gdenv/main/scripts/install.ps1" `
-OutFile "./install-gdenv.ps1"; `
&"./scripts/install-gdenv.ps1"
&"./install-gdenv.ps1"; `
Remove-Item "./install-gdenv.ps1"
```
## **Documentation**
Expand Down
6 changes: 3 additions & 3 deletions scripts/install.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
updates environment variables as needed.
.PARAMETER NoModifyPath
Do not modify the \$PATH environment variable.
Do not modify the $PATH environment variable.
.PARAMETER Version
Install the specified version of 'gdenv'.
Expand All @@ -45,10 +45,10 @@
# ------------------------------ Define: Params ------------------------------ #

Param (
# NoModifyPath help if set, the user's $PATH variable won't be updated
# NoModifyPath - if set, the user's $PATH variable won't be updated
[Switch] $NoModifyPath = $False,

# Version help override the specific version of 'gdenv' to install
# Version - override the specific version of 'gdenv' to install
[String] $Version = "v0.5.2" # x-release-please-version
)

Expand Down

0 comments on commit 9fa6007

Please sign in to comment.