@algolia/utm-attribution
v3.3.1
Published
Package used to set `utm` values in a cookie, restricted to algolia domain and subdomains
Maintainers
Keywords
Readme
UTM Attribution (Algolia domains)
This NPM package aims to unify our capture and storage strategy towards UTMs (Urchin Tracking Module) on all Algolia domains/sub-domains (Website, Blog, Dashboard, Docs, etc.).
Cookie consent
algolia_website_utm_params should be classified as a Strictly Necessary cookie (C0001). The package captures the landing URL or referrer and writes the cookie on load, regardless of OneTrust availability or optional category consent.
Configure this cookie as Strictly Necessary in OneTrust separately. Consumer sites must upgrade to a release containing this change to get the new behavior.
If a site loads the browser build with a <script> tag, load it normally and remove the previous type="text/plain" and optanon-category-C0004 attributes:
<script src="https://cdn.jsdelivr.net/npm/@algolia/utm-attribution/dist/browser/index.min.js"></script>How to contribute
- Clone this repository:
git clone [email protected]:algolia/utm-attribution.git- Create a branch, update the code, and make a commit and a PR to
developfollowing SEMVER versioning convention.
Releases
Once you consider that the develop branch holds enough changes to release a new version, here are the 5 steps to follow:
make sure you're releasing the correct version:
- Breaking change, bump the first number (1.2.3 -> 2.0.0) - Major
- New feature, bump the second number (1.2.3 -> 1.3.0) - Minor
- Bug fixing, bump the third number (1.2.3 -> 1.2.4) - Patch
- Unsure? Check SEMVER
run
npm version [your_version]. This will automatically:- checkout
develop - create a branch named with the version number
- update the version number
- push it to GitHub
- checkout
have a look at the auto-generated CHANGELOG.md. Update some information manually if needed, commit and push it
create two PRs:
- one to merge
[your_version]intodevelop(this will update thepackage.jsonversion) - the other one to merge
[your_version]intomain.
- one to merge
run
npm run publishoryarn publishto push the new release to npm.
