Skip to content

Commit

Permalink
docs: fix plugin example (export verifyConditions, not verify) (#…
Browse files Browse the repository at this point in the history
…2192)

plugin example was exporting `verify`, not `verifyConditions`
  • Loading branch information
JoA-MoS committed Oct 18, 2021
1 parent a50dc99 commit 8db804b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/developer-guide/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ We recommend you setup a linting system to ensure good javascript practices are
In your `index.js` file, you can start by writing the following code

```javascript
const verifyConditions = require('./src/verify');
const verify = require('./src/verify');

let verified;

Expand All @@ -43,12 +43,12 @@ let verified;
* @param {*} pluginConfig The semantic-release plugin config
* @param {*} context The context provided by semantic-release
*/
async function verify(pluginConfig, context) {
await verifyConditions(pluginConfig, context);
async function verifyConditions(pluginConfig, context) {
await verify(pluginConfig, context);
verified = true;
}

module.exports = { verify };
module.exports = { verifyConditions };
```

Then, in your `src` folder, create a file called `verify.js` and add the following
Expand Down

0 comments on commit 8db804b

Please sign in to comment.