Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix links to install.sh #432

Merged
merged 2 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See the [release page](https://github.com/warrensbox/terraform-switcher/releases

For macOS or various Linux distributions, Homebrew offers the simplest installation process. <a href="https://brew.sh/" target="_blank">If you do not have homebrew installed, click here</a>.

```ruby
```shell
brew install warrensbox/tap/tfswitch
```

Expand All @@ -46,7 +46,7 @@ brew install warrensbox/tap/tfswitch
Installation for Linux operating systems.

```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash
```

## Arch User Repository (AUR) packages for Arch Linux
Expand Down
4 changes: 2 additions & 2 deletions www/docs/Continuous-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#!/bin/bash

echo "Installing tfswitch locally"
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh #Get the installer on to your machine

chmod 755 install.sh #Make installer executable

Expand Down Expand Up @@ -48,7 +48,7 @@ jobs:

echo "Installing tfswitch locally"

wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh #Get the installer on to your machine

chmod 755 install.sh #Make installer executable

Expand Down
10 changes: 5 additions & 5 deletions www/docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ See the [release page](https://github.com/warrensbox/terraform-switcher/releases
## Homebrew
Installation for macOS is the easiest with Homebrew. <a href="https://brew.sh/" target="_blank">If you do not have homebrew installed, click here</a>.

```ruby
```shell
brew install warrensbox/tap/tfswitch
```

## Linux
Installation for Linux operating systems.

```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash
```

By default installer script will try to download `tfswitch` binary into `/usr/local/bin`
To install at custom path use below:
```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash -s -- -b $HOME/.local/bin
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash -s -- -b $HOME/.local/bin
```

By default installer script will try to download latest version of `tfswitch` binary
To install custom (not latest) version use:
```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash -s -- 1.1.1
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash -s -- 1.1.1
```

Both options can be combined though:
```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash -s -- -b $HOME/.local/bin 1.1.1
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash -s -- -b $HOME/.local/bin 1.1.1
```

## Arch User Repository (AUR) packages for Arch Linux
Expand Down
2 changes: 1 addition & 1 deletion www/docs/Troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Solution: You probably need to have privileges to install *tfswitch* at /usr/loc
Try the following:

```sh
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine:
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh #Get the installer on to your machine:

chmod 755 install.sh #Make installer executable

Expand Down
6 changes: 3 additions & 3 deletions www/docs/Upgrade-or-Uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

### Homebrew

```ruby
```shell
brew upgrade warrensbox/tap/tfswitch
```
### Linux

Rerun:

```sh
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/master/install.sh | bash
```

## Uninstall:

### Homebrew

```ruby
```shell
brew uninstall warrensbox/tap/tfswitch
```
### Linux
Expand Down
4 changes: 2 additions & 2 deletions www/docs/usage/config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This is similiar to using a .tfswitchrc file, but you can specify a custom binar
4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory(current directory) OR in your home directory(~/.tfswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory
5. Your `.tfswitch.toml` file should look like this:

```ruby
```toml
bin = "$HOME/bin/terraform"
version = "0.11.3"
```
Expand All @@ -69,7 +69,7 @@ bin = "C:\\Users\\<%USRNAME%>\\bin\\terraform.exe"
If a terragrunt.hcl file with the terraform constraint is included in the current directory, it should automatically download or switch to that terraform version.
For example, the following should automatically switch terraform to the lastest version 0.13:

```ruby
```hcl
terragrunt_version_constraint = ">= 0.26, < 0.27"
terraform_version_constraint = ">= 0.13, < 0.14"
...
Expand Down