@axah/components-sales

@axah/components-sales

Reusable CI/CD Components at AXA Healthcare switzerland.

Installing a release

Install @axah/components-sales using the following command:

pnpm add @axah/components-sales

Creating a release

Create a release on github and name the tag in the format vMAJOR.MINOR.PATCH and the github action in .github/workflows/publish.yml will take care of publishing the package to npm.

Note: As this technique currently updates the npm dist-tag latest to whatever release you create you should either not use this technique to cut a prerelease (i.e. using pattern vMAJOR.MINOR.PATCH-PRERELEASE.NUMBER) or a patch/minor version of an old major/minor OR fix the npm dist-tag afterwards using npm dist-tag @axah/components-sales@<latest version> latest

Release notes

• 0.0.17:
  • Implement the most important DSN Components

This Component Sales library uses the following:

• Typescript
• Rollup
• Prettier
• ESLint
• StyleLint
• Storybook
• SCSS
• Semantic Release
• Github Actions
• Hygen

##CSS Structure If you are working with scss, you can import the index.scss in the scss folder. This way you have imported all ".scss" files from the styles folder. If you want to import them individually, simply import the corresponding file.

If you do not work with scss, you can import the different styles of the components as ".css" from the css folder.

├── .styles
├── css
│   ├── Component.scss
├── scss
│   ├── index.scss
│   ├── global.scss
│   ├── typography.scss
│   ├── ...

Folder Structure

├── .storybook
├── src
│   ├── components
|   |   ├── atoms
|   |   |   ├── YourComponent
|   |   |   |   ├── YourComponent.scss
|   |   |   |   ├── YourComponent.stories.tsx
|   |   |   |   ├── YourComponent.tsx
|   |   |   |   ├── index.ts
|   |   ├── molecules
|   |   |   ├── YourComponent
|   |   |   |   ├── YourComponent.scss
|   |   |   |   ├── YourComponent.stories.tsx
|   |   |   |   ├── YourComponent.tsx
|   |   |   |   ├── index.ts
|   |   ├── organisms
|   |   |   ├── YourComponent
|   |   |   |   ├── YourComponent.scss
|   |   |   |   ├── YourComponent.stories.tsx
|   |   |   |   ├── YourComponent.tsx
|   |   |   |   ├── index.ts
|   |   ├── index.ts
|   ├── index.ts
├── LICENSE
├── package.json
├── README.md

Add a new component

Once you have created your new component make sure you have exported it in the src/components/index.ts file. Doing so allows the component to be compiled into the final bundle using rollup.

Storybook

pnpm storybook

Building your library

pnpm build

The build output will go into the dist directory

Github Actions

This project contains a github action workflow called ci.yaml. This workflow runs a job that will test, lint, and build the code. If the code passes and you are on the master branch it will also run the publish job to send the new version off to npm.

Publishing your Library on NPM

Once you have created an account on NPM create a publish key and add it to your github secrets as NPM_TOKEN. You will also need to create another secret called SEMANTIC_RELEASE_TOKEN. This token should be a personal access token that has the following scopes: repo(all). Semantic Release will take care of the publishing and versioning for you via the .github/workflows/ci.yaml Publish job. In addition to publishing to NPM it will also create a new tag and release with commit messages in the repo.

Note: You will need to update the package.json name property with the correct name your library will be using on npm.

Known Issues

Warning: Prop className did not match. Server: "css-b8ldur-Input" Client: "css-1g6gooi" at div (First Page)

Warning: Expected server HTML to contain a matching <div> in <div>. at div at EmotionCssPropInternal (Personal Details)