Upgrade to latest Netlify build API

[ehmicky]

Thanks a lot for creating this Build plugin!

Netlify just released the latest version of Build plugins. Build plugins are currently enabled in the Netlify website for a small percentage of beta users.

This PR upgrades this plugin to the latest API. You can find the new documentation here.

I don't have a Cypress setup, so you definitely would want to manually test the different changes introduced by this PR.

List of the changes:

• Added keywords to package.json to make it easier for users to find your plugin
• Added a bugs keyword to package.json which will be printed to users if a bug happens inside your plugin
• Replace execa with Netlify's run utility, which is based on Execa (note: I am a co-maintainer of Execa)
• When pings on wait-on fail, use utils.build.failPlugin() (which will be reported as a user error) instead of throwing an error (which would be reported as a bug inside your plugin)
• On errors, use utils.build.failPlugin() instead of utils.build.failBuild() to ensure other plugins keep running.
• Avoid plugin's top-level function since this might be deprecated in the future and is not currently used by this plugin
• Remove the name property, which has been removed from Netlify
• The preBuild and postBuild events have been renamed to onPreBuild and onPostBuild
• Use the PUBLISH_DIR constant instead of netlifyConfig.build.publish. This constant not only uses the configuration file property build.publish but also the setting "Publish directory" set in the Netlify app.
• pluginConfig was renamed to inputs
• Remove return value from event handlers, since those are reserved for future usage

Note: checking that utils.build exists should not be needed in production. The only way this would not exist is for users running a local build with an old version Netlify CLI, but upgrading should fix their problem.

Those are quite many changes, so if you find any time to confirm that each works by running actual builds, this would be amazing! Thanks. 🙏

[CLAassistant]

All committers have signed the CLA.

[bahmutov]

Looks good, let me try this tomorrow before publishing. I think this does not even have user-facing changes, so could be even a patch version update.

[bahmutov]

actually, steps were renamed, so user would have to use onPreBuild - but this early in the game, I guess a minor version is still fine

[ehmicky]

Oh yes, you're right. You could either make a breaking change and support only passing the new event name, or keep backward compatibility there.

Please let me know if you have any additional questions, I'm here to help! :)

[bahmutov]

Looks good, I will merge this so I release a beta version to test it out, then will set up CI tests before publishing an official version, thanks for the work @ehmicky I really appreciate this

[bahmutov]

@ehmicky do the users still need to specify inputs to onPreBuild callback as [plugins.inputs.preBuild] or should it now be [plugins.inputs.onPreBuild]?

[bahmutov]

also @ehmicky I have noticed the pre-build callback failing, yet the build has succeeded? https://circleci.com/gh/cypress-io/netlify-plugin-cypress/96

[bahmutov]

🎉 This PR is included in version 1.3.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[ehmicky]

@ehmicky do the users still need to specify inputs to onPreBuild callback as [plugins.inputs.preBuild] or should it now be [plugins.inputs.onPreBuild]?

I kept it as inputs.preBuild but providing the new name (either as a breaking change or backward compatible) might be a good idea?

I have noticed the pre-build callback failing, yet the build has succeeded?

This PR switched from using utils.build.failBuild() (which makes whole build fail) to using utils.build.failPlugin() (which makes only this specific plugin fail). Which one you prefer to use depends on how strict/lenient your plugin should be when it comes to the whole build. Netlify favors being lenient but surfacing the errors in the UI (which is currently a WIP). However if you think the Cypress should be stricter, failBuild() should be used instead 👍