Migrate plugins from/to `onPostBuild` and `onSuccess`

[ehmicky]

The full background of the discussion is here.

onPostBuild happens before deploy, and can prevent a build from being deployed.
onSuccess happens after deploy, and cannot prevent a build from being deployed.

We should send PRs to migrate plugins that either:

• use onPostBuild, but the logic should happen after deploy
• use onEnd, but errors should prevent a build from being deployed

After this is done, we should also send PRs to migrate plugins that use utils.build.failBuild() or utils.build.cancelBuild() within onSuccess, onEnd or onError.

[erezrokah]

Partial list of plugins:

• lighthouse plugin
• is site vulnerable plugin

[ehmicky]

This is the list of plugins to review:

• onSuccess
  • https://github.com/tkadlec/netlify-build-plugin-speedcurve/blob/master/index.js
  • https://github.com/philhawksworth/netlify-plugin-minify-html/blob/master/index.js
  • https://github.com/AshikNesin/netlify-plugin-pushover/blob/master/index.js
  • https://github.com/erezrokah/netlify-plugin-is-website-vulnerable/blob/master/src/index.js
  • https://github.com/borisschapira/netlify-build-plugin-dareboost/blob/master/index.js
  • https://github.com/cdeleeuwe/netlify-plugin-submit-sitemap/blob/master/index.js
  • https://github.com/netlify-labs/netlify-plugin-lighthouse/blob/master/src/index.js
  • https://github.com/perfbeacon/netlify-build-plugin-perfbeacon/blob/master/index.js
  • https://github.com/DebugBear/netlify-build-plugin-debugbear/blob/master/index.js
• onEnd
  • https://github.com/chrism2671/netlify-purge-cloudflare-on-deploy/blob/master/index.js
  • https://github.com/netlify-labs/netlify-plugin-debug-cache/blob/master/index.js
• onError
  • https://github.com/AshikNesin/netlify-plugin-pushover/blob/master/index.js
• onPostBuild
  • https://github.com/lukeocodes/netlify-plugin-algolia-index/blob/main/index.js
  • https://github.com/munter/netlify-plugin-checklinks/blob/master/lib/index.js
  • https://github.com/munter/netlify-plugin-subfont/blob/master/lib/index.js
  • https://github.com/munter/netlify-plugin-hashfiles/blob/master/lib/index.js
  • https://github.com/jlengstorf/netlify-plugin-visual-diff/blob/main/index.js
  • https://github.com/netlify-labs/netlify-plugin-sitemap/blob/master/index.js
  • https://github.com/sw-yx/netlify-plugin-no-more-404/blob/master/index.js
  • https://github.com/sw-yx/netlify-plugin-search-index/blob/master/index.js
  • https://github.com/netlify-labs/netlify-plugin-a11y/blob/master/plugin/index.js
  • https://github.com/cypress-io/netlify-plugin-cypress/blob/master/src/index.js
  • https://github.com/Tom-Bonnike/netlify-plugin-inline-source/blob/master/index.js
  • https://github.com/Tom-Bonnike/netlify-plugin-inline-critical-css/blob/master/index.js
  • https://github.com/getsentry/sentry-netlify-build-plugin/blob/master/index.js
  • https://github.com/martinbean/netlify-plugin-amp-server-side-rendering/blob/master/src/index.js
  • https://github.com/chrisdwheatley/netlify-plugin-image-optim/blob/master/index.js
  • https://github.com/oliverroick/netlify-plugin-html-validate/blob/master/index.js
  • https://github.com/Brikl/opensource/blob/master/libs/netlify-plugin-next-dynamic/src/index.ts
  • https://github.com/ample/netlify-plugin-replace/blob/main/index.js

What to report:

• onPostBuild: if the logic is meant to happen after deploy (onSuccess should be used instead then)
• onSuccess/onEnd/onError: if errors within the event handler itself are meant to prevent the build from deploying (onPostBuild should be used instead then)
• onSuccess/onEnd/onError: using utils.build.failBuild() or utils.build.cancelBuild() (utils.build.failPlugin() should be used instead)

[erezrokah]

Plugin	Uses Events	Invokes failBuild	Migration Needed	Migration Status	Assigned To
netlify-build-plugin-speedcurve	onSuccess	Yes	Switch to failPlugin	Done	@erezrokah
netlify-plugin-minify-html	onSuccess	No	Switch to onPostBuild	Done	@erezrokah
netlify-plugin-pushover	onSuccess,onError	Yes	Switch to failPlugin	Done	@erezrokah
netlify-plugin-is-website-vulnerable	onSuccess	Yes	Switch to onPostBuild	Done	@erezrokah
netlify-build-plugin-dareboost	onSuccess	No	None	Not Relevant
netlify-plugin-submit-sitemap	onSuccess	No	None	Not Relevant
netlify-plugin-lighthouse	onSuccess	Yes	Switch to onPostBuild	Done	@erezrokah
netlify-build-plugin-perfbeacon	onSuccess	Yes	Switch to failPlugin	Done	@erezrokah
netlify-build-plugin-debugbear	onSuccess	No	None	Not Relevant
netlify-purge-cloudflare-on-deploy	onEnd	Yes	Switch to failPlugin, Use onSuccess instead of onEnd	Done	@erezrokah
netlify-plugin-debug-cache	onEnd	No	None	Not Relevant
sentry-netlify-build-plugin	onPostBuild	Yes	Switch to onSuccess and to failPlugin	Pending	@erezrokah

Other

Need to decide about https://github.com/lukeocodes/netlify-plugin-algolia-index and https://github.com/lukeocodes/netlify-plugin-algolia-export. See #104.
Once we do the plugin needs to migrate to onSuccess instead of onPostBuild.

[erezrokah]

@ehmicky, this is a partial table (missing onPostBuild plugins. Going to add them soon Added the relevant ones from onPostBuild