Merge pull request danskernesdigitalebibliotek#82 from danskernesdigitalebibliotek/release/2

Release 2 - PR

Author: cableman

.github/workflows/a11y.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
       - run: npm ci
 
       - name: Compile styles

.github/workflows/chromatic.yml

@@ -10,9 +10,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
 
       - run: npm ci
 

.github/workflows/deployment.yml

@@ -8,9 +8,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
       - run: npm ci
 
       - name: Building
@@ -41,9 +41,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
           registry-url: "https://npm.pkg.github.com"
           scope: "@${{ github.repository_owner }}"
 

.github/workflows/gh-pages.yml

@@ -13,9 +13,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
 
       - name: Cache dependencies
         uses: actions/cache@v2

.github/workflows/lint.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
       - run: npm ci
 
       - name: Run stylelint
@@ -29,9 +29,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
       - run: npm ci
 
       - name: Run eslint
@@ -41,9 +41,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
 
       - run: npm ci
 
@@ -54,9 +54,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version-file: '.nvmrc'
 
       - run: npm ci
 

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore markdown since linter uses other rules than Prettier
+*.md
+
+# Ignore Yaml since linter uses other rules than Prettier
+*.yml

README.md

@@ -117,6 +117,28 @@ styles and icons.
 You can find the HTML output for a given story under the HTML tab inside
 storybook.
 
+### NPM package
+
+[The GitHub NPM package registry requires authentication if you are to access
+packages there](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token).
+
+Consequently, if you want to use the design system as an NPM package or if you
+use a project that depends on the design system as an NPM package you must
+authenticate:
+
+1. [Create a GitHub token with the required scopes: `repo` and `read:packages`](https://github.com/settings/tokens/new?description=npm&scopes=repo,read:packages)
+2. Run `npm login --registry=https://npm.pkg.github.com`
+3. Enter the following information:
+
+```shell
+> Username: [Your GitHub username]
+> Password: [Your GitHub token]
+> Email: [An email address used with your GitHub account]
+```
+
+Note that you will need to reauthenticate when your personal access token
+expires.
+
 ## Deployment
 
 The project is getting rebuild on pushes to every branch and every tag. In

Taskfile.yml

@@ -7,7 +7,7 @@ vars:
     sh: git rev-list --count origin/main
 
   # Constructing docker image name.
-  DOCKER_IMAGE_PREFIX: "{{ .RELEASE_IMAGE_REGISTRY }}/{{ .DOCKER_IMAGE_NAMESPACE }}"
+  DOCKER_IMAGE_PREFIX: '{{ .RELEASE_IMAGE_REGISTRY }}/{{ .DOCKER_IMAGE_NAMESPACE }}'
 
   # Constructing docker image name.
   RELEASE_IMAGE_NAME: '{{.RELEASE_IMAGE_NAME | default "dpl-cms-source"}}'
@@ -28,7 +28,7 @@ tasks:
     summary: Install and run docker compose
     cmds:
       - task dev:install
-      - docker compose up --detach
+      - docker compose {{ .DOCKER_COMPOSE_FILES }} up --detach
 
   dev:stop:
     summary: Stop docker compose environment
@@ -47,10 +47,14 @@ tasks:
     cmds:
       - docker compose logs node --follow
 
+  dev:axe:
+    summary: Run accessibility tests
+    cmds:
+      - task dev:cli -- npm run storybook:axe
+
   dev:reset:
     summary: Install development environment and clean up.
     cmds:
-      - task dev:cli -- storybook:axe
       - task dev:down
       - rm -rf node_modules
       - task dev:up

base.scss

@@ -26,6 +26,11 @@
 @import "./src/stories/counter/counter";
 @import "./src/stories/checkbox/checkbox";
 @import "./src/stories/availability-label/availability-label";
+@import "./src/stories/search-result-item/search-result-item";
+@import "./src/stories/icon/icon-favourite/icon-favourite";
+@import "./src/stories/autosuggest-text/autosuggest-text";
+@import "./src/stories/button-favourite/button-favourite";
+@import "./src/stories/autosuggest-material/autosuggest-material";
 
 @import "./src/stories/list-reservation/list-reservation";
 @import "./src/stories/list-dashboard/list-dashboard";

docker-compose.yml

@@ -2,7 +2,9 @@ version: '3.7'
 
 services:
   node:
-    image: node:16
+  # Remember to keep version updated with the .nvmrc file.
+  # The .nvmrc file is used in Github Actions and for "dockerless" development.
+    image: node:16.14.2
     user: node
     init: true
     working_dir: /home/node/app