Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netlify/build-plugin-template
Template repository to create new Netlify Build plugins.
https://github.com/netlify/build-plugin-template
bash build ci continuous-delivery continuous-deployment continuous-integration continuous-testing deployment es6 javascript linux macos netlify netlify-plugins nodejs plugins serverless shell terminal windows
Last synced: about 1 month ago
JSON representation
Template repository to create new Netlify Build plugins.
- Host: GitHub
- URL: https://github.com/netlify/build-plugin-template
- Owner: netlify
- License: mit
- Created: 2020-01-17T18:59:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T12:09:17.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:37:19.968Z (about 2 months ago)
- Topics: bash, build, ci, continuous-delivery, continuous-deployment, continuous-integration, continuous-testing, deployment, es6, javascript, linux, macos, netlify, netlify-plugins, nodejs, plugins, serverless, shell, terminal, windows
- Language: JavaScript
- Size: 16.4 MB
- Stars: 32
- Watchers: 5
- Forks: 17
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/build-plugin-template/deploys)
Template repository to create new Netlify Build plugins.
The main Build plugins documentation can be found
[here](https://docs.netlify.com/configure-builds/build-plugins/).
# Initialization
To create a repository with a new Netlify Build plugin, click on the
["Use this template" button](https://github.com/netlify/build-plugin-template/generate)
on top of the page.
The repository name should start with `netlify-plugin-`, for example
`netlify-plugin-gatsby`.
[Clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
locally.
Inside the new repository directory, run the following command.
```
npm run init
```
Some questions will be asked. Make sure the plugin's name matches the repository
name.
Among other things, this will replace this `README.md` with the plugin's user
documentation. Development documentation will still be available in the
[`CONTRIBUTING.md`](/CONTRIBUTING.md#development-tasks).
Finally, create a Netlify Site with the repository. This will automatically run
your Build plugins in Netlify Build on every `git push`, as a smoke test.
You can also add a
[Netlify status badge](https://docs.netlify.com/monitor-sites/status-badges/).
# Usage
The plugin's logic should be added to [`./src/index.js`](/src/index.js).
Comments in that file will guide you through the creation of a Build plugin.
## Development tasks
The following development tasks are available. Please check the
[`package.json`](/package.json) `scripts` property for more information.
```bash
npm run build
```
Runs a Netlify Build locally with the current plugin. This can be used for
debugging and manual tests.
The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be
modified.
```bash
npm run ava
```
Runs [unit tests](/test/index.js).
```bash
npm run lint
```
Lints and prettifies source files.
```bash
npm test
```
Runs both unit tests and linting.
```bash
npm run release
```
Publishes this plugin to `npm`.