Skip to content

Commit

Permalink
docs: release docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
daphnesmit committed Mar 28, 2024
1 parent e05fbe9 commit 12706dd
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README_DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ npm i && npm dev
- ⚡️[tsup](https://github.com/egoist/tsup) - The simplest and fastest way to bundle your TypeScript libraries. Used to bundle package as ESM and CJS modules. Supports TypeScript, Code Splitting, PostCSS, and more out of the box.
- 📖 [Storybook](https://storybook.js.org/) - Build UI components and pages in isolation. It streamlines UI development, testing, and documentation.
- 🧪 [Vitest](https://vitest.dev/) - A testing framework for JavaScript. Preconfigured to work with TypeScript and JSX.
- 🔼 [Release-it](https://github.com/release-it/release-it/) - release-it is a command line tool to automatically generate a new GitHub Release and populates it with the changes (commits) made since the last release.
- 🔼 [Semantic Release](https://github.com/semantic-release/semantic-release) - semantic-release automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the package.
- 🐙 [Test & Publish via Github Actions](https://docs.github.com/en/actions) - CI/CD workflows for your package. Run tests on every commit plus integrate with Github Releases to automate publishing package to NPM and Storybook to Github Pages.
- 📄 [Commitizen](https://github.com/commitizen/cz-cli) — When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time.
- 🐶 [Husky](https://github.com/typicode/husky) — Run scripts before committing.
Expand Down Expand Up @@ -86,22 +86,4 @@ npm commit

### 🔖 Releasing, tagging & publishing to NPM

Create a semantic version tag and publish to Github Releases. When a new release is detected a Github Action will automatically build the package and publish it to NPM. Additionally, a Storybook will be published to Github pages.

Learn more about how to use the `release-it` command [here](https://github.com/release-it/release-it).

```console
npm release
```

When you are ready to publish to NPM simply run the following command:

```console
npm publish
```

#### 🤖 Auto publish after Github Release (or manually by dispatching the Publish workflow)

❗Important note: in order to automatically publish a Storybook on Github Pages you need to open your repository settings, navigate to "Actions" and enable **"Read & write permissions"** for Workflows. Then navigate to "Pages" and choose **"GitHub Actions"** as the source for the Build and Deployment. After a successful deployment you can find your Storybook at `https://<your-github-username>.github.io/<your-repository-name>/`.

❗Important note: in order to publish package to NPM you must add your token as a Github Action secret. Learn more on how to configure your repository and publish packages through Github Actions [here](https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages).
Create a semantic version tag and when your pr gets merged to develop or main it will publish a release to Github Releases. The Github Action will automatically publish it to NPM. Additionally, a Storybook will be published to Github pages.

0 comments on commit 12706dd

Please sign in to comment.