Skip to content

Update Homebrew installation to use spinframework tap #37

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 28, 2025
Merged

Update Homebrew installation to use spinframework tap #37

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c97623a
Update Homebrew installation to use spinframework tap
kate-goldenring Mar 27, 2025
065ad1a
Update cache directory information for Homebrew
kate-goldenring Mar 27, 2025
080016e
Update tap name to spinframework
kate-goldenring Mar 28, 2025
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
8 changes: 4 additions & 4 deletions content/v1/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
Copy link
Contributor

@itowlson itowlson Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sanity check that it's correct to use the new tap for old (v1 and v2) versions

Copy link
Contributor Author

@kate-goldenring kate-goldenring Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With brew you can't use old versions of Spin -- rather you can only pull latest. People using older Spin will be on the fermyon tap still. I'm not sure what is best here. Happy to update

Copy link
Contributor

@itowlson itowlson Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for explaining! No need to change!

$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install the Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Copy link
Contributor

@vdice vdice Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, sorry, just noticed this one; can we update "fermyon tap" to "spinframework tap" here and in the other spots?

Copy link
Contributor Author

@kate-goldenring kate-goldenring Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vdice this was my thought process around v1 and v2 #37 (comment)

Copy link
Contributor

@vdice vdice Mar 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I just meant can we replace "Spin is accessed from the fermyon tap" on line 48 with "Spin is accessed from the spinframework tap"?

Copy link
Contributor Author

@kate-goldenring kate-goldenring Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh nice! Thanks! Yes.

Copy link
Contributor Author

@kate-goldenring kate-goldenring Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated! Thanks for catching this!

Expand Down Expand Up @@ -96,15 +96,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install the Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Expand Down
2 changes: 1 addition & 1 deletion content/v1/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ If you installed Spin using [Homebrew](https://brew.sh/) please use the followin

```bash
$ brew update
$ brew upgrade fermyon/tap/spin
$ brew upgrade spinframework/tap/spin
```

## Troubleshooting
Expand Down
8 changes: 4 additions & 4 deletions content/v2/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Expand Down Expand Up @@ -95,15 +95,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Expand Down
2 changes: 1 addition & 1 deletion content/v2/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If you installed Spin using [Homebrew](https://brew.sh/) please use the followin

```bash
$ brew update
$ brew upgrade fermyon/tap/spin
$ brew upgrade spinframework/tap/spin
```

### Cargo
Expand Down
6 changes: 3 additions & 3 deletions content/v3/cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Spin uses similar layouts across Linux, MacOS and Windows platforms, but the pat

| Name | Linux | MacOS | Windows |
|---------------------|------------------------------------------|--------------------------------------|-------------------|
| `DATA_DIR` | `$XDG_DATA_HOME` or `$HOME/.local/share` | `$HOME/Library/Application Support`, or `$HOMEBREW_PREFIX/etc/fermyon-spin` if installed using Homebrew | `%LOCALAPPDATA%` or `%USERPROFILE%\AppData\Local` |
| `DATA_DIR` | `$XDG_DATA_HOME` or `$HOME/.local/share` | `$HOME/Library/Application Support`, or `$HOMEBREW_PREFIX/etc/fermyon-spin` for Spin <v3.2 and `$HOMEBREW_PREFIX/etc/spinframework-spin` for Spin >=v3.2 if installed using Homebrew | `%LOCALAPPDATA%` or `%USERPROFILE%\AppData\Local` |
| `CACHE_DIR` | `$XDG_CACHE_HOME` or `$HOME/.cache` | `$HOME/Library/Caches` | `%LOCALAPPDATA%` or `%USERPROFILE%\AppData\Local` |

These directories are based on the [XDG specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), and specifically on the cross-platform implementation in the [Rust `dirs` crate](https://docs.rs/dirs/latest/dirs/).
Expand All @@ -38,15 +38,15 @@ These directories are based on the [XDG specification](https://specifications.fr

Installed plugins are stored in `(DATA_DIR)/spin/plugins`. A snapshot of the plugins registry is also stored under that directory at `(DATA_DIR)/spin/plugins/.spin-plugins`; this is structured as a Git repository.

> Note: If you [install Spin](./install) using Homebrew, the plugins are stored at `$HOMEBREW_PREFIX/fermyon-spin/plugins`.
> Note: If you [install Spin](./install) using Homebrew, the plugins are stored at `$HOMEBREW_PREFIX/spinframework-spin/plugins` (previously `$HOMEBREW_PREFIX/fermyon-spin/plugins`).

If you delete the plugins directory, you will no longer be able to run your plugins (until you reinstall them), but other Spin operations will be unaffected.

## Templates

Installed templates are stored in `(DATA_DIR)/spin/templates`.

> Note: If you [install Spin](install) using Homebrew, the templates are stored at `$HOMEBREW_PREFIX/fermyon-spin/templates`.
> Note: If you [install Spin](install) using Homebrew, the templates are stored at at `$HOMEBREW_PREFIX/spinframework-spin/templates` (previously `$HOMEBREW_PREFIX/fermyon-spin/templates`).

If you delete the templates directory, you will lose access to your installed templates (until you reinstall them), but other Spin operations will be unaffected.

Expand Down
8 changes: 4 additions & 4 deletions content/v3/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Expand Down Expand Up @@ -95,15 +95,15 @@ Install the Fermyon tap, which Homebrew tracks, updates, and installs Spin from:
<!-- @selectiveCpy -->

```bash
$ brew tap fermyon/tap
$ brew tap spinframework/tap
```

Install Spin:

<!-- @selectiveCpy -->

```bash
$ brew install fermyon/tap/spin
$ brew install spinframework/tap/spin
```

> Note: `brew install spin` will **not** install Spin framework. Spin is accessed from the `fermyon` tap, as shown above.
Expand Down
2 changes: 1 addition & 1 deletion content/v3/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If you installed Spin using [Homebrew](https://brew.sh/) please use the followin

```bash
$ brew update
$ brew upgrade fermyon/tap/spin
$ brew upgrade spinframework/tap/spin
```

### Cargo
Expand Down