@rabbitio/ui-kit 1.0.0-beta.42 → 1.0.0-beta.45

package/.gitlab-ci.yml

@@ -0,0 +1,29 @@
+stages:
+  - build
+  - test
+#  - release
+
+test:
+  stage: test
+  image: node:iron
+  cache:
+    key: "$CI_COMMIT_REF_SLUG"
+    paths:
+    - node_modules/
+  variables:
+    GIT_STRATEGY: fetch
+  script:
+    - npm install --force --no-fund # --no-optional
+    - npm run test
+
+build:
+  stage: build
+  image: node:iron
+  cache:
+    key: "$CI_COMMIT_REF_SLUG"
+    paths:
+    - node_modules/
+  script:
+    - HUSKY=true npm install --force --no-fund
+    # use "- unset CI" if needed to ignore warnings - dirty workaround due to React's way to fail builds having warnings
+    - npm run build

package/.husky/commit-msg

@@ -0,0 +1,8 @@
+#!/bin/sh
+# Hook script to ensure commit messages end with 'task_id=[a-zA-Z0-9]+'
+COMMIT_REGEXP='task_id=[,a-zA-Z0-9]+$'
+
+if ! grep -qE "$COMMIT_REGEXP" "$1"; then
+    echo "ERROR: Commit message doesn't end with task_id"
+    exit 1
+fi

package/.husky/pre-push

@@ -0,0 +1 @@
+npm run build && git diff --quiet || (echo 'Uncommitted changes detected. Please commit or stash them. If you have no uncommitted changes this error is caused by running npm run build - you forget to do this. Please add build result to commit and retry.' && exit 1)

package/README.md

@@ -29,8 +29,8 @@ import "@rabbitio/ui-kit/index.css";
 ~~~
 
 # Adding new component
-1. Add a directory for component under the semantically corresponding subdirectory inside **./stories**
-2. Under the component directory implement 3 files: **<Component>.js**, **<Component>.module.scss**, **<Component>.stories.js**
+1. Add a directory for component under the semantically corresponding subdirectory inside **./src/components** and add **<Component>.js**, **<Component>.module.scss** to this directory
+2. Under the **./stories** directory repeat the directories structure from **./src/components** and implement **<Component>.stories.js** there
 3. Add the implemented component import to barrel file **./stories/index.js**
 ~~~javascript
 export { default as <Component> } from "./path/to/<Component>";
@@ -45,9 +45,18 @@ sudo docker run -d -p 6006:6006 storybook-app
 ~~~
 
 # Publishing
-1. Increase version number and commit
-2. Run:
+1. Increase version number
+2. Run npm run build. Ensure that all the uncommitted changes are planned to be published as build command will build them all into the bundle.  
+3. Commit and push changes
+4. Run:
 ~~~bash
 npm login
 npm publish --access public
 ~~~
+
+# Dev details
+1. The repository uses husky to assure
+   1. each commit message ends with task_id=<id>
+   2. there is no uncommitted changes when pushing (to avoid pushing not built changes)
+2. The repository follows git-flow branching model
+3. There is a basic CI/CD setup