# npmsemver

> [!CAUTION]
> This is an experimental package resulting from [this repo](https://github.com/svaraborut/npmsemver). Its sole purpose
> is
> to experiment with semantic versioning and GitHub Action release automation. USE IT AT YOUR OWN DISCRETION.

## Steps

### Technologies

- **Typescript**. Configured for modern `ES2020` builds. Provides two import aliases `@` and `@test`
- **Prettier**. With sane code cleaning defaults and automated import sorting.
- **Vite**. Configured to build to exclude all the Node builtins, `peerDependencies` and `devDependencies` from the
  bundle.
    - `npm run build` to build `src/index.ts` as a library
    - `npm run dev` to serve the contents of `demo` in development mode for experimentation with the library

### 1. Prepare the repository

- Create a GitHub repository with a `name` and `description`
- Prepare the project with `git` and `npm` initialized. Provide `name` `description` and `author`. Version should be
  `1.0.0`. This repository also includes all this [technologies](#technologies)
- Push to GitHub

### 2. Automation

Versioning is automated via the `semantic-versioning` solution. The configuration is present
in [.releaserc.mjson](.releaserc.mjs) and is configured with a san default that will:

- Maintain the `CHANGELOG.md` file
- Automatically manage releases via the `main` branch
- Automatically manage canary releases via the `canary` branch
- Handle GitOps. By [default](https://github.com/semantic-release/git) the commit user is `@semantic-release-bot`. The
  actions are:
    - Issues mentioned in release commits will receive a comment with the release
    - Pull requests will receive a comment with the release
- Update the package version and create a `bot()` commit to bump package when creating a production release

> [!TIP]
> Order of plugins in the array is important as it denotes the order of execution of the plugins. Which implies that
`npm` should always precede `github` to prevent the creation of tags and release notes for failed `npm` publishes.

## Docs

Actual example of working badges

[![svara.io](https://svara.io/assets/badge.svg)](https://svara.io/)
[![Main](https://github.com/svaraborut/npmsemver/actions/workflows/main.yml/badge.svg)](https://github.com/svaraborut/npmsemver/actions/workflows/main.yml)
[![NPM Version](https://img.shields.io/npm/v/%40svara%2Fnpmsemver)](https://www.npmjs.com/package/@svara/npmsemver)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

Dummy library documentation. Not intended for production use.

Generate a random fruit emoji

```typescript
import { fruit, fruitSalad, animal, zoo } from '@svara/npmsemver'

fruit() // -> 🍊

fruitSalad() // -> 🥝🫐🫒🍊🍇🍍

animal() // -> 🦎

zoo() // -> 🐞🦋🐓🐢🦝🐴
```

## Todo

- How to [move index.html](https://stackoverflow.com/questions/71295772) to `demo`
- Publish `index.html` to GitHub pages