diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de60fa0..01332d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,3 +41,26 @@ yarn lint # fix style and formatting errors yarn format ``` + +## Releases + +> **TODO:** Configure an automatic release process with GitHub actions. + +1. Create a new version + ```bash + yarn version [ major | minor | patch | prerelease ] + ``` +2. Update changelog and commit + ```bash + git add -u + git commit -m "vX.Y.Z" + git tag -a "vX.Y.Z" + ``` +3. Publish to npm + ```bash + yarn npm publish [ --tag alpha ] + ``` +4. Push to GitHub + ```bash + git push && git push --tags + ``` diff --git a/package.json b/package.json index 5f67314..831e65b 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ { "name": "@carto/api-client", - "version": "0.0.1-0", + "version": "0.0.1-1", "publishConfig": { "access": "public", "tag": "alpha" }, - "packageManager": "yarn@4.2.2", + "packageManager": "yarn@4.3.1", "author": "Don McCurdy ", "license": "UNLICENSED", "type": "module", @@ -36,10 +36,8 @@ "lint": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --check", "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --write", "clean": "rimraf build/*", - "version": "git add -u", "prepack": "yarn clean && yarn build", - "prepublish": "yarn lint && yarn test", - "postpublish": "git push && git push --tags" + "prepublish": "yarn lint && yarn test" }, "files": [ "build", @@ -84,6 +82,5 @@ "vite": "^5.2.10", "vitest": "1.6.0", "vue": "^3.4.27" - }, - "stableVersion": "0.0.0" + } }