|
1 | | -[](https://app.netlify.com/sites/build-plugin-template/deploys) |
| 1 | +Netlify Build plugin identity-sso - Protect a site with SSO via identity. |
2 | 2 |
|
3 | | -Template repository to create new Netlify Build plugins. |
| 3 | +# Install |
4 | 4 |
|
5 | | -The main Build plugins documentation can be found |
6 | | -[here](https://docs.netlify.com/configure-builds/build-plugins/). |
| 5 | +Please install this plugin from the Netlify app. |
7 | 6 |
|
8 | | -# Initialization |
| 7 | +# Configuration |
9 | 8 |
|
10 | | -To create a repository with a new Netlify Build plugin, click on the |
11 | | -["Use this template" button](https://github.com/netlify/build-plugin-template/generate) |
12 | | -on top of the page. |
13 | | - |
14 | | -The repository name should start with `netlify-plugin-`, for example |
15 | | -`netlify-plugin-gatsby`. |
16 | | - |
17 | | -[Clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) |
18 | | -locally. |
19 | | - |
20 | | -Inside the new repository directory, run the following command. |
21 | | - |
22 | | -``` |
23 | | -npm run init |
24 | | -``` |
25 | | - |
26 | | -Some questions will be asked. Make sure the plugin's name matches the repository |
27 | | -name. |
28 | | - |
29 | | -Among other things, this will replace this `README.md` with the plugin's user |
30 | | -documentation. Development documentation will still be available in the |
31 | | -[`CONTRIBUTING.md`](/CONTRIBUTING.md#development-tasks). |
32 | | - |
33 | | -Finally, create a Netlify Site with the repository. This will automatically run |
34 | | -your Build plugins in Netlify Build on every `git push`, as a smoke test. |
35 | | - |
36 | | -You can also add a |
37 | | -[Netlify status badge](https://docs.netlify.com/monitor-sites/status-badges/). |
38 | | - |
39 | | -# Usage |
40 | | - |
41 | | -The plugin's logic should be added to [`./src/index.js`](/src/index.js). |
42 | | -Comments in that file will guide you through the creation of a Build plugin. |
43 | | - |
44 | | -## Development tasks |
45 | | - |
46 | | -The following development tasks are available. Please check the |
47 | | -[`package.json`](/package.json) `scripts` property for more information. |
48 | | - |
49 | | -```bash |
50 | | -npm run build |
51 | | -``` |
52 | | - |
53 | | -Runs a Netlify Build locally with the current plugin. This can be used for |
54 | | -debugging and manual tests. |
55 | | - |
56 | | -The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be |
57 | | -modified. |
58 | | - |
59 | | -```bash |
60 | | -npm run ava |
61 | | -``` |
62 | | - |
63 | | -Runs [unit tests](/test/index.js). |
64 | | - |
65 | | -```bash |
66 | | -npm run lint |
67 | | -``` |
68 | | - |
69 | | -Lints and prettifies source files. |
70 | | - |
71 | | -```bash |
72 | | -npm test |
73 | | -``` |
74 | | - |
75 | | -Runs both unit tests and linting. |
76 | | - |
77 | | -```bash |
78 | | -npm run release |
79 | | -``` |
80 | | - |
81 | | -Publishes this plugin to `npm`. |
| 9 | +The following `inputs` options are available. |
0 commit comments