SHARED(Docs): Add new section for installation instructions

.github/workflows/shared_frontend.yml

@@ -9,6 +9,7 @@ on:
       - "!**/*.md"
 env:
   FRONTEND_DIR: ./frontend
+  GITHUB_REGISTRY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.gitignore

@@ -62,4 +62,4 @@ dist
 !**/.yarn/plugins
 !**/.yarn/releases
 !**/.yarn/sdks
-!**/.yarn/versions
+!**/.yarn/versions

docker-compose-akt.yml

@@ -28,6 +28,8 @@ services:
     build:
       context: ./frontend
       dockerfile: Dockerfile.akt
+      args:
+        - GITHUB_REGISTRY_TOKEN=${GITHUB_REGISTRY_TOKEN}
     ports:
       - "4000:4000"
     working_dir: /app/reactjs

docker-compose-otr.yml

@@ -28,6 +28,8 @@ services:
     build:
       context: ./frontend
       dockerfile: Dockerfile.otr
+      args:
+        - GITHUB_REGISTRY_TOKEN=${GITHUB_REGISTRY_TOKEN}
     ports:
       - "4000:4000"
     working_dir: /app/reactjs

docs/shared_frontend.md

@@ -32,3 +32,21 @@ In this project directory, you can run:
     │   └── styles              # SCSS styles
     │   └── utils               # Utils
     └── ...
+
+## How to install the package?
+
+1. Create an access token as instructed [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), and select ONLY `read:packages` as the scope
+2. Add created token to your bash profile:
+
+   ```sh
+    PROFILE_ADDRESS=~/.zshrc  # Depends on your current active profile. ~/.zshrc or ~/.bashrc
+    echo 'export GITHUB_REGISTRY_TOKEN="created_token_here"' >> $PROFILE_ADDRESS
+   ```
+
+3. Reload bash profile configs
+
+   ```sh
+     source $PROFILE_ADDRESS
+   ```
+
+4. Run `yarn add @opetushallitus/kieli-ja-kaantajatutkinnot.shared@version` to install the package

frontend/.yarnrc.yml

@@ -5,7 +5,9 @@ enableTelemetry: false
 nodeLinker: node-modules
 
 npmScopes:
-  "@opetushallitus":
+  "opetushallitus":
     npmRegistryServer: "https://npm.pkg.github.com"
+    npmAlwaysAuth: true
+    npmAuthToken: ${GITHUB_REGISTRY_TOKEN}
 
 yarnPath: .yarn/releases/yarn-3.2.0.cjs

frontend/Dockerfile.akt

@@ -2,6 +2,8 @@ FROM node:16.14.2-alpine
 
 RUN corepack enable
 
+ARG GITHUB_REGISTRY_TOKEN
+
 # Create app directory
 WORKDIR /app/reactjs
 

frontend/Dockerfile.otr

@@ -2,6 +2,8 @@ FROM node:16.14.2-alpine
 
 RUN corepack enable
 
+ARG GITHUB_REGISTRY_TOKEN
+
 # Create app directory
 WORKDIR /app/reactjs
 

frontend/packages/shared/CHANGELOG.MD

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Released]
 
+## [1.0.3] - 2022-05-09
+
+### Added
+
+- Installation instructions
+
 ## [1.0.2] - 2022-05-09
 
 ### Fixed
@@ -19,7 +25,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- missing style imports on shared components
+- Missing style imports on shared components
 
 ### Changed
 

frontend/packages/shared/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opetushallitus/kieli-ja-kaantajatutkinnot.shared",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Shared Frontend Package",
   "exports": {
     "./components": "./src/components/index.tsx",