Merge pull request #32 from citation-file-format/ci-workflows

Ci workflows

Author: fdiblen

.github/workflows/build.yml

@@ -1,8 +1,14 @@
 name: Build
 
-on: [push, pull_request]
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - main
+      - 'releases/*'
 
 jobs:
+
   build:
 
     runs-on: ubuntu-latest
@@ -19,7 +25,9 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm clean-install
-    - run: npm run build
+    - name: Run npm clean-install
+      run: npm clean-install
+    - name: Run build
+      run: npm run build
 
 

.github/workflows/lint.yml

@@ -1,9 +1,15 @@
 name: Lint
 
-on: [push, pull_request]
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - main
+      - 'releases/*'
 
 jobs:
-  build:
+
+  lint:
 
     runs-on: ubuntu-latest
 
@@ -19,5 +25,7 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm clean-install
-    - run: npm run lint
+    - name: Run npm clean-install
+      run: npm clean-install
+    - name: Run linting
+      run: npm run lint

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - main
+      - 'releases/*'
+
+jobs:
+
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - name: Run npm clean-install
+      run: npm clean-install
+    - name: Run unit tests
+      run: npm run test:unit:ci
+
+

README.dev.md

@@ -11,7 +11,6 @@ The notes about technology choices, design, personas can be found in [project-do
 ```shell
 # clone this repository
 git clone https://github.com/citation-file-format/cffinit
-
 # change directory
 cd cffinit
 ```
@@ -21,7 +20,7 @@ cd cffinit
 The command below will install dependencies
 
 ```shell
-npm install
+npm clean-install
 ```
 
 ## start the development server
@@ -60,7 +59,7 @@ npx husky install
 
 ## Tests
 
-We use Jest for unit tests. To run unit tests (`src/**/*.jest.spec.ts`)
+We use Jest for unit tests. To run unit tests (`test/jest/__tests__/**/*.jest.spec.ts`)
 
 You can run the test with
 

src/pages/Start.vue

@@ -1,25 +1,37 @@
 <template>
   <div class="window-height window-width row justify-center items-center">
-    <q-card>
-      <q-card-title><h1>Start Page</h1></q-card-title>
-      <q-card-main>
+    <q-card
+      dark
+      bordered
+      class="bg-grey-9 my-card"
+    >
+      <q-card-section>
+        <div class="text-h6">
+          Start Page
+        </div>
+        <div class="text-subtitle2">
+          by John Doe
+        </div>
+      </q-card-section>
+
+      <q-separator
+        dark
+        inset
+      />
+
+      <q-card-section>
         <p
-          v-for="n in 10"
+          v-for="n in 5"
           :key="n"
         >
           Lorem ipsum dolor sit amet consectetur adipisicing elit. Fugit nihil praesentium molestias a adipisci, dolore vitae odit, quidem consequatur optio voluptates asperiores pariatur eos numquam rerum delectus commodi perferendis voluptate?
         </p>
-      </q-card-main>
-
-      <q-card-separator />
-
-      <q-card-actions align="right">
         <q-btn
           color="grey-6"
-          label="Continue"
+          label="Get started"
           to="/1"
         />
-      </q-card-actions>
+      </q-card-section>
     </q-card>
   </div>
 </template>

src/pages/Start.jest.spec.ts …/jest/__tests__/pages/Start.jest.spec.tssrc/pages/Start.jest.spec.ts renamed to test/jest/__tests__/pages/Start.jest.spec.ts src/pages/Start.jest.spec.ts renamed to test/jest/__tests__/pages/Start.jest.spec.ts

@@ -2,7 +2,7 @@ import { beforeEach, describe, expect, it } from '@jest/globals'
 import { installQuasarPlugin } from '@quasar/quasar-app-extension-testing-unit-jest'
 import { shallowMount, VueWrapper } from '@vue/test-utils'
 
-import Start from './Start.vue'
+import Start from '../../../../src/pages/Start.vue'
 
 // Specify here Quasar config you'll need to test your component
 installQuasarPlugin()

src/store/step.jest.spec.ts …t/jest/__tests__/store/step.jest.spec.tssrc/store/step.jest.spec.ts renamed to test/jest/__tests__/store/step.jest.spec.ts src/store/step.jest.spec.ts renamed to test/jest/__tests__/store/step.jest.spec.ts

@@ -1,6 +1,6 @@
 import { beforeEach, describe, expect, it } from '@jest/globals'
 import * as vue from 'vue'
-import { useStep } from './step'
+import { useStep } from '../../../../src/store/step'
 
 describe('useStep', () => {
     let step: {