GoldenEye W3C

GoldenEye W3C is a hybrid library designed to work with both the AWS CDK and the AWS SDK. This library enables seamless integration of W3C checks into an AWS CodePipeline and handles reporting in GitHub Pull Requests.

Overview

GoldenEye W3C provides two distinct modules:

• CDK Module: This module helps create and attach a W3C check to an AWS CodePipeline. It allows for seamless integration of the W3C validation process into your pipeline.
• SDK Module: The SDK module manages how the results of the W3C check are reported within GitHub's Pull Requests, ensuring that code quality is continuously monitored.

The W3C check implementation is based on the goldeneye-w3c-submitter Docker image.

How It Works

CodePipeline Integration

GoldenEye adds the StageOptions generated by the CDK part. This allows you to attach a W3C check to your pipeline, ensuring that all changes are compliant with W3C standards.

1. The docker-compose.yml file is published as an S3 artifact.
2. This artifact is downloaded and executed within the CodeBuild phase of your CodePipeline.
3. The CodeBuild project uses the goldeneye-w3c-submitter Docker image to run the W3C checks.
4. Results from the checks are generated and processed.

GitHub Pull Request Reporting

The SDK module handles reporting for GitHub Pull Requests. After the W3C check completes, the results are posted back to the associated Pull Request, ensuring that all changes are compliant with W3C standards.

Installation

npm install

Usage

Make sure you have session credentials for the AWS account 478262784215 (PLOP Dev)

export VALIDATOR_SUBMITTER_IMAGE=478262784215.dkr.ecr.eu-central-1.amazonaws.com/goldeneye-w3c:latest

Test

Run npm run test to execute the CDK tests.

CDK Integration

To integrate W3C checks into your AWS CodePipeline using the AWS CDK:

npm install goldeneye-w3c