Continuous Integration Boilerplate

Project boilerplate set up with Continuous Integration

Features

GitHub Actions:

• Automated testing/building with isolated virtual machines.

Pre-commit Hooks:

• Enforces linter styles and runs tests

Test Configuration:

• Sample Jest configuration file

Scripts:

• npm run lint:check: check files with ESLint styles
• npm run test: run ALL test files
• npm run test:watch: test files with auto refresh
• npm run test:branch: run tests only on branch

Boilerplate Setup

• config.js: add configuration variables
• .env: update enviroment variables
• README.md: change badge URLS => spencerlepine/continuous-integration-boilerplate to username/repo

📦 Technologies:

• GitHub Actions
• Husky
• ESLint
• Lint-Staged
• Jest
• Coveralls.io

Overview:

GitHub Actions:

• Triggers on main branch push
• Triggers on branch push or PR
• executes npm test
• executes npm lint:check
• Comments coverage on each Pull Request
• Uploads TEST coverage to Coveralls.io

Pre-commit hooks

• Enforces linter styles
• Runs npm test to check before updating remote
• Note: npm run husky:remove:
  • package.json script: deletes husky files
  • macOS command: rm -f .husky/pre-commit && rm -f .husky/pre-push

---

spencerlepine.com  ·  GitHub @spencerlepine  ·  Twitter @spencerlepine