alu/cse110-fa22-group29
1
0
Fork 0
mirror of https://github.com/cse110-fa22-group29/cse110-fa22-group29.git synced 2024-11-14 14:56:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
a722d755fd
cse110-fa22-group29/admin/cipipeline/phase2.md
Arthur Lu 793e7891b3 prettier style fixes 
Signed-off-by: Arthur Lu <learthurgo@gmail.com>
2022-12-03 02:02:52 +00:00

2.1 KiB
Raw Blame History

CI/CD Phase 2

Overall Pipeline Architecture

Rather than create one large pipeline with many steps which increases complexity, we decided to create many small independent pipelines which work in parallel to conduct code quality checking. Using this strategy, if any one pipeline has issues, we can still continue development without delay, and the quality of code is likely to remain high.

Overview of Pipeline Features

We've identified 5 major features which we definitely want to implement in the CI/CD pipeline.

  • Deployment
  • Unit Testing
  • Linting
  • End To End Validation
  • Manual Validation

We also identified some features which are nice to have:

  • Automatic documentation publishing
  • Minification
  • HTML Validation and accessibility scoring

We created this diagram to demonstrate our strategy of multiple simple pipelines.

Pipeline Diagram

Finished Features and Implementation

So far the features listed below have been completed to some degree:

  • Deployment
    • Implemented: action triggered on any push to main, uses the github pages action to publish the app
    • Implemented: uses JSDoc to generate documentation on the same site at docs
    • ToDo: Add minification step between trigger and github pages action
  • Unit Testing
    • Implemented: action triggers on PR to main, uses mocha to perform unit testing on core components
  • End to end testing
    • Implemented: action triggers on PR to main, uses mocha and puppeteer to perform end to end testing
  • Linting (JS)
    • Implemented: action triggers on PR to main, uses eslint to perform style enforcement on all JS components
  • Linting (HTML)
    • Implemented: action triggers on PR to main, uses HTMLhint to perform style enforcement on all HTML components
  • Linting (CSS)
    • Implemented: action triggers on PR to main, uses Stylelint to perform style enforcement on all CSS components
  • Linting (general)
    • Implemented: action triggers on PR to main, uses Prettier to perform style checking on all file types

Planned Features and Timeline