lando/plugin-template

Starter Template for Lando Plugins

Plugin Template

Use this repo as a template for creating Lando plugins.

Steps

1. Copy this repo into your new plugin repo
2. Change the items marked CHANGEME to the name of this plugin in the following files:
   • docs/config.js
   • docs/README.md
   • .lando.yml
   • actions-lando-config.yml
   • plugin.yml
   • package.json
3. Add in your files or migrate the files from another plugin.
4. Add in your testing examples and add them to .github/workflows
5. Copy the docs config page into usage.md in the docs folder.
6. Remove these steps and alter the changeme text below.
7. PROFIT!

Lando CHANGEME Plugin

The lando CHANGEME plugin service.

Installation

# With npm
npm install @lando/CHANGEME

# With yarn
yarn add @lando/CHANGEME

Issues, Questions and Support

If you have a question or would like some community support we recommend you join us on Slack. Note that this is the Slack community for Lando but we are more than happy to help with this module as well!

If you'd like to report a bug or submit a feature request then please use the issue queue in this repo.

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Development

• Requires Node 14+
• Prefers Yarn

git clone https://github.com/lando/CHANGEME.git && cd CHANGEME
yarn install

If you dont' want to install Node 14 or Yarn for whatever reason you can install Lando and use that:

git clone https://github.com/lando/CHANGEME.git && cd CHANGEME
# Install deps and get node
lando start

# Run commands
lando node
lando yarn

Testing

# Lint the code
yarn lint

# Run unit tests
yarn test

Releasing

yarn release

Contributors

Made with contributors-img.

Other Resources

• Important advice