Skip to content

Commit

Permalink
Init
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeocodes committed May 19, 2021
1 parent 7ebd126 commit 6903e9e
Show file tree
Hide file tree
Showing 24 changed files with 1,855 additions and 3,639 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Command line options and/or configuration file, if any.
Enter the following command in a terminal and copy/paste its output:

```bash
npx envinfo --system --binaries --browsers --npmPackages netlify-plugin-{{name}}
npx envinfo --system --binaries --browsers --npmPackages netlify-plugin-gatsby
```

**Screenshots**
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at {{email}}.
reported by contacting the project team at [email protected].

All complaints will be reviewed and investigated and will result in a response
that is deemed necessary and appropriate to the circumstances. The project team
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) {{year}} {{author}}
Copyright (c) 2021 Luke Oliff

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
82 changes: 5 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,9 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/79deda3b-d696-4878-b15d-d9f3a862bdfc/deploy-status)](https://app.netlify.com/sites/build-plugin-template/deploys)
Netlify Build plugin gatsby - Run Gatsby seamlessly on Netlify.

Template repository to create new Netlify Build plugins.
# Install

The main Build plugins documentation can be found
[here](https://docs.netlify.com/configure-builds/build-plugins/).
Please install this plugin from the Netlify app.

# Initialization
# Configuration

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`.
The following `inputs` options are available.
9 changes: 0 additions & 9 deletions init/README.md

This file was deleted.

66 changes: 0 additions & 66 deletions init/bin.js

This file was deleted.

61 changes: 0 additions & 61 deletions init/clean.js

This file was deleted.

13 changes: 0 additions & 13 deletions init/copy.js

This file was deleted.

39 changes: 0 additions & 39 deletions init/main.js

This file was deleted.

12 changes: 0 additions & 12 deletions init/options.js

This file was deleted.

Loading

0 comments on commit 6903e9e

Please sign in to comment.