@digdir/ds-id-porten v0.7.12

ID-porten Storybook

Dette prosjektet inneheld komponentane til ID-porten i dokumentasjonsverktøyet Storybook.

Sette opp Storybook lokalt

1. Installer NODE (LTS)

2. Installer yarn globalt (sudo på linux)

npm install --global yarn

3. Installer avhengigheiter ved å kjøyre kommandoen frå root mappa (der package.json fila ligg)

yarn install

4. Start Storybook lokalt

yarn dev

Commit ✍️

Start commits med fix:, feat:, eller BREAKING CHANGE: for å få de med i endringsloggen (se CHANGELOG.md i pakkene) som automatisk oppdateres på Storybook når nye versjoner publiseres. Dette burde gjøres på commits som endrer innholdet i det som publiseres (filene som bygges).

Ved neste versjonering/publisering vil fix: trigge en patch (0.0.x), feat: en minor update (0.x.0), og BREAKING CHANGE: alene eller etter fix:/feat: vil trigge en major update (x.0.0).

Første linje (og eventuelt det etter BREAKING CHANGE:) i commit-teksten blir automatisk lagt til i endringsloggen i pakken til der commiten gjør en endring. Legg til et scope med parantes, se eksempel under:

fix(button): short description of what commit does (e.g. add secondary variant style)

Longer in-depth description in a paragraph here, if needed.

BREAKING CHANGE: Explanation of things that break with this commit and what users need to do to migrate, if needed.
In this case it could be that a fix in the button changes the HTML structure of the button component, 
which requires the users to modify their implementation using the @digdir/ds-core-css package.

Les mer om Conventional Commits på https://conventionalcommits.org.

Versjonering og publisering 🚀

For å byggje filer til distribusjon og publisere desse til NPM, gjer følgjande:

1. Kjøyr denne kommandoen for å oppdatere versjonsnummer og generere ny changelog:

yarn release

Når du får spørsmål om versjon, trykk på enter. Commit meldingane vil automatisk oppdatere til riktig versjon basert på om det er ein FIX, FEAT eller BREAKING CHANGE (sjå commit seksjonen over).

2. Oppdater versjonsnummer manuelt i ./storybook/stories/changelog.stories.mdx

Totalt 3 plassar versjonsnummer skal oppdaterast (2 gonger i CDN og 1 gong i zip nedlasting). Dette steget bør automatiseret med versjonen frå package.json i framtiden.

3. Bygg distribusjonsfilene:

yarn build

Dette vil lage ei "dist" mappe og ei ZIP fil med den nye versjonen.

4. Commit og push endringane du gjorde i changelog og dei nye distribusjonsfilene:

git commit -m "release x.x.x" && git push --follow-tags origin main

Viktig at "--follow-tags" blir med slik at changeloggen blir riktig generert.

5. Publiser til NPM

yarn publish

Lenke til ID-porten Storybook

https://felleslosninger.github.io/idporten-design-system/

Lisens

BSD 3-Clause License

• Laga av Øyvind Thune (oyvind.thune@digdir.no)