fish-shop/install-plugin-manager

A GitHub action for installing a fish shell plugin manager.

---

Prerequisites

This action requires fish shell. You can install it using the fish-shop/install-fish-shell action.

Usage

Add a suitable uses step to your GitHub workflow and specify the plugin manager to be installed by providing a value for the plugin-manager input as shown below:

- name: Install Fisher plugin manager
  uses: fish-shop/install-plugin-manager@v2
  with:
    plugin-manager: fisher

Supported plugin managers

The following table lists the supported plugin managers and the corresponding plugin-manager input value to use in your workflow:

Plugin manager	plugin-manager value
Fisher	fisher
Oh My Fish	oh-my-fish1
plug.fish	plug.fish2

Managing plugins

After installing one of the supported plugin managers listed above, you may interact with it directly in subsequent steps of your workflow to install, remove, and manage plugins as desired.

For example, to install the Pond plugin using Fisher:

- name: Install Pond plugin with Fisher
  run: fisher install marcransome/pond
  shell: fish {0}

Refer to the official documentation for the specific plugin manager being used for additional information.

Action versions

Use one of the following patterns when specifying the version reference for this action in your workflow (i.e. the {ref} value in uses: fish-shop/install-plugin-manager@{ref}):

Pattern	Example	Description
vX	v2	the latest v2.* release including non-breaking changes and bug fixes
vX.Y	v2.1	the latest v2.1.* release including bug fixes
vX.Y.Z	v2.1.0	the v2.1.0 release only

Tip

The recommended pattern is vX (e.g. v2). This will ensure that the version of the action used in your workflow includes the latest non-breaking changes and bug fixes, and guarantees compatibility with previous versions of that major release number.

Using a main branch reference in your workflow is not recommended as this branch may include breaking changes intended for the next major release.

Other GitHub actions

A number of related composite actions are also available from the fish-shop 🐟. Check them out:

• fish-shop/indent-check - A GitHub action for checking indentation in fish shell files
• fish-shop/install-fish-shell - A GitHub action for installing fish shell
• fish-shop/syntax-check - A GitHub action for syntax checking fish shell files
• fish-shop/install-plugin - A GitHub action for installing fish shell plugins
• fish-shop/run-fishtape-tests - A GitHub action for running Fishtape tests

Acknowledgements

• Fish market icon made by Freepik from www.flaticon.com

License

fish-shop/install-plugin-manager is provided under the terms of the MIT License.

Contact

Email me at marc.ransome@fidgetbox.co.uk or create an issue.

Footnotes

1. Oh My Fish is currently unmaintained and support for this plugin manager may be removed in a future update. ↩

2. plug.fish support was removed in v2.0.0 due to upstream changes that are generally incompatible with the use of this plugin manager in the context of GitHub Actions. ↩