Merge pull request #118 from jackdomleo7/workflow-improvements

.github/workflows/Linting.yml → .github/workflows/Build.yml

@@ -1,4 +1,4 @@
-name: Linting
+name: Build
 
 on:
   push:
@@ -9,15 +9,19 @@ on:
     - master
 
 jobs:
-  lint:
+  build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
       - name: Install Node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: '14.x'
       - name: Clean install npm dependencies
         run: npm ci
+      - name: Check project can build successfully
+        run: npm run build
+      - name: Check git is still clean after building
+        run: npm run has-no-changes
       - name: Check project linting
         run: npm run lint:check

.github/workflows/Tests.yml

@@ -12,7 +12,7 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
       - uses: cypress-io/github-action@v2
         with:
           browser: chrome

README.md

@@ -176,8 +176,8 @@ _This project uses npm8 and Node >= 14 - however any project using this package
 5. Edit `src/**/*.scss` and run `npm run build` in the root of the project to regenerate the CSS found at `/checka11y.css` (DO NOT edit this file directly).
 6. To add error/warning styles and messages to your features, `@extend` one of the placeholders and `@include contentMessage()` from `src/_base.scss`.
 7. Add tests to your features in cypress folder (edit the element file or create a new one if needed)
-8. Run tests: `npm run cypress:open` or `npm run cypress:run` (headless)
-  - You can also run tests for a specific tag/attribute by doing `npm run cypress:run -- --spec cypress/integration/{file-to-test}`
+8. Run tests: `npm run cypress:open` or `npm run test` (headless)
+  - You can also run tests for a specific tag/attribute by doing `npm run test -- --spec cypress/integration/{file-to-test}`
 9. Add the feature to the [features.md](./features.md) & [codes.md](./codes.md) with a new error or warning code
 
 ---