Skip to content

Commit

Permalink
(docs): add publishing info
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjr82 committed Nov 16, 2022
1 parent 5f7fcef commit 0bee5ab
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,14 @@ function sidebar() {
// { text: 'Input forms', link: '/examples/input-forms' },
]
},
// {
// text: 'Development',
// collapsible: true,
// items: [
// { text: 'Introduction', link: '/development/introduction' },
// { text: 'Tests', link: '/development/tests' },
// ]
// }
{
text: 'Development',
collapsible: true,
items: [
{ text: 'Introduction', link: '/development/introduction' },
{ text: 'Tests', link: '/development/tests' },
{ text: 'Publishing', link: '/development/publishing' },
]
}
]
}
38 changes: 38 additions & 0 deletions docs/development/publishing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Pubishing

## Setup to publish in NPM

In command line:

```bash
npm adduser
```

## Publish in NPM

In command line:

```bash
npm version x.y.z
npm version [major | minor | patch]
npm version x.y.z --no-git-tag-version # use this if release is created in github first
```

For example, to release a patch version:

```bash
npm version patch -m "(dev): tag %s"
npm publish --access public
```

These commands will create a tag in git, so push to repo after them.

Also, create a release in the repo after all.

## Deprecate package

In command line:

```bash
npm deprecate <package-name>@<version> "<message>"
```

0 comments on commit 0bee5ab

Please sign in to comment.