Skip to content

Commit

Permalink
Add release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy committed Jun 25, 2024
1 parent 8f229a2 commit 435ff52
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
11 changes: 4 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
"license": "UNLICENSED",
"type": "module",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -84,6 +82,5 @@
"vite": "^5.2.10",
"vitest": "1.6.0",
"vue": "^3.4.27"
},
"stableVersion": "0.0.0"
}
}

0 comments on commit 435ff52

Please sign in to comment.