Semantic-release-mixpanel NPM

📦🚀📊 Semantic Release Mixpanel

Create Mixpanel annotations from new releases.

Step	Description
`verifyConditions`	Verify the required environment variables
`success`	Create an annotation in Mixpanel with information about the most recent release
`fail`	(nothing)

npm install --dev semantic-release-mixpanel

Add the following to your release.config.js

  "plugins": [
    // ...
   ["semantic-release-mixpanel", {
       "semverFilter": ["major", "minor"]
   }]
  ],

Your Mixpanel project ID along with Service Account credentials are required. To learn how to create a service account, see Mixpanel Docs.

Environment variable	Description
`MIXPANEL_PROJECT_ID`	Project ID available in the URL
`MIXPANEL_SERVICE_ACCOUNT_USERNAME`	Username
`MIXPANEL_SERVICE_ACCOUNT_PASSWORD`	Password

Property	Type	Default	Example	Description
`skipCommit`	`String`	`undefined`	`"skipCommit": "^fix\\(deps\\):"`	Skips notifying when `regex` matches at least one commit in the release
`semverFilter`	`String[]`	`["major", "minor", "patch"]`	`"semverFilter": ["major", "minor"]`	Skips releases that do not match one of the configured types
`fullReleaseNotes`	`Boolean`	`false`	`"fullReleaseNotes": true`	Provides the full release notes in the annotation instead of a link to the release notes

2 years ago