Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

28 lines (16 loc) · 2.07 KB

How to code a plugin

Testing

End-to-end tests are in folder tests and they use this plugin locally and build each subfolder using Netlify CLI on CircleCI. You can find the test recordings at Cypress Dashboard

To run locally:

  • npx netlify link once
  • from every subfolder of tests execute npm run build

Authentication (local)

  • use netlify-cli to authenticate locally. It will also create a local site and store its ID in .netlify folder (ignored by git)

Authentication (ci)

To authenticate netlify on CircleCI:

  • grab the Settings > Site information > APP ID and set it as environment variable NETLIFY_SITE_ID
  • generate new authentication token for CI from User Settings > Applications > New Access Token and set it as environment variable NETLIFY_AUTH_TOKEN

Releasing a new version

Before releasing check that each CircleCI job has actually run the tests correctly. We don't have a way to check if Cypress executed all tests, other than looking at the CircleCI terminal output.

Try using beta branch to release new pre-release versions of the plugin by following the semantic release guide. You can fork and test out new versions published to NPM using the netlify-plugin-cypress-example repository. Hope the master branch merged into beta does not bring features and fixes already released. Thus I suggest using beta branch for new features.

Do not open pull request on CircleCI while adding new features to the beta branch. If there is a pull request, semantic-release refuses to publish new versions. Instead just watch the builds on CircleCI directly and open the PR after the new version has been tested.