fish-shop/install-plugin

A GitHub action for installing fish shell plugins.

---

Prerequisites

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

Usage

Add a suitable uses step to your GitHub workflow and specify the plugin manager and plugin(s) to be installed by providing values for the plugin-manager and plugins inputs respectively:

jobs:
  install-plugin:
    runs-on: ubuntu-latest
    steps:
      - name: Install Pond plugin with Fisher
        uses: fish-shop/install-plugin@v2
        with:
          plugin-manager: fisher
          plugins: marcransome/pond

The value provided for the plugins input is passed unchanged as an argument to the install command of the specified plugin manager. In most cases this means multiple plugins may be installed at the same time, however this is dependent upon the plugin manager being used. Refer to the official documentation for the chosen plugin manager for details (see Supported plugin managers for a list of supported tools and links to their respective project repositories).

The plugin manager will be installed only if not already present. If your workflow job contains multiple install-plugin actions that use the same plugin manager then only the first action will install the plugin manager.

If you wish to install a plugin manager in isolation, without installing any plugins at the same time, consider using the fish-shop/install-plugin-manager action instead.

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-fish
plug.fish	plug.fish1

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@{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/syntax-check - A GitHub action for syntax checking fish shell files
• fish-shop/install-plugin-manager - A GitHub action for installing a fish shell plugin manager
• 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 is provided under the terms of the MIT License.

Contact

Email me at [email protected] or create an issue.

Footnotes

1. plug.fish support was removed in v2.0.0 due to functional changes made in recent versions of this plugin manager. ↩