Netlify Build plugin — FlyCode
Usage
Installation
In order to use this plugin, install it as a dependency to your project using
npm install --save @flycode/netlify-plugin
or
yarn add @flycode/netlify-plugin
Configuration
Next (and last) step is to use this plugin in Netlify config file.
If you don't have such file, create netlify.toml file in your project's root directory with contents:
[[plugins]]
package = "@flycode-org/netlify-plugin-flycode"
If netlify.toml already exists in your project, add the code above at the end of that file, to achieve similar result:
[[plugins]]
package = "..."
[[plugins]]
package = "..."
[[plugins]]
package = "@flycode-org/netlify-plugin-flycode"
And that's it! 🎉
Make sure to commit changes made to this file and either merge these to the main branch through a Pull Request or push directly.
In your next Netlify deploy you should see the plugin in action.
Advanced options
Instead of configuring the plugin to be used in every deploy, you can configure it to be executed only in certain cases.
The case we focus on is Deploy Preview, so if you want to avoid running this plugin on production deploy (see below why it's not a big deal), you might want to add this to the netlify.toml instead:
[[context.deploy-preview.plugins]]
package = "@flycode-org/netlify-plugin-flycode"
Why [[plugins]] is no big deal
Our plugin will proceed with its job only if it detects the current context is Deploy Preview. This means that when it's a Production deploy, you will most likely see a message:
Not a deploy preview. Skipping...
And that will conclude our plugin's life.
Debugging
Debugging allows you to view during its execution a stringified data that is used in the plugin. This includes:
- netlifyConfig
- process.env variables
- inputs
- constants
- git metadata
- and html that is injected
For debugging options, you can specify a debug mode as shown below:
[[plugins]]
package = "@flycode-org/netlify-plugin-flycode"
[plugins.inputs]
debug = true
For the deploy-preview context:
[[context.deploy-preview.plugins]]
package = "@flycode-org/netlify-plugin-flycode"
[context.deploy-preview.plugins.inputs]
debug = true