We need to create a GitHub pipeline action that will ensure the integrity of our markup format by verifying that only tags are used and that no additional classes are introduced in the text. This check should be performed on every commit to maintain consistency and adherence to our formatting rules.
Background
This repository contains the markup format of a book, primarily written in HTML. To ensure the content does not include its formatting, we have restricted tags to only . We use CSS classes to distinguish between components, including native HTML elements. This approach requires strict enforcement to prevent unauthorized tags or classes from being added.
Requirements
Tag Verification:
Ensure that only tags are present in the HTML content.
Identify and flag any unauthorized tags in the entire repository or preferably in the changed files for each commit.
Class Verification:
Check that no additional classes have been introduced in the text.
Validate that all classes used adhere to the predefined set of allowed classes.
Acceptance Criteria
A GitHub Action is created that runs on each commit.
The action scans the entire repository or the changed files to verify that only tags are used.
The action checks that no new classes are added, except those that are predefined.
If any unauthorized tags or classes are detected, the action should fail and provide a detailed report of the issues.
The action should be efficient and not significantly increase the commit time.
Additional Information
Allowed Tags: <span> only.
Allowed Classes: Look into the Directory structuring guideOutput: Detailed report highlighting the unauthorized tags and classes, including file names and line numbers.
Performance: Ensure the action runs efficiently without significantly slowing down the CI/CD pipeline.
Description
We need to create a GitHub pipeline action that will ensure the integrity of our markup format by verifying that only tags are used and that no additional classes are introduced in the text. This check should be performed on every commit to maintain consistency and adherence to our formatting rules.
Background
This repository contains the markup format of a book, primarily written in HTML. To ensure the content does not include its formatting, we have restricted tags to only . We use CSS classes to distinguish between components, including native HTML elements. This approach requires strict enforcement to prevent unauthorized tags or classes from being added.
Requirements
Tag Verification:
Class Verification:
Acceptance Criteria
Additional Information
Allowed Tags:
<span>only. Allowed Classes: Look into the Directory structuring guide Output: Detailed report highlighting the unauthorized tags and classes, including file names and line numbers. Performance: Ensure the action runs efficiently without significantly slowing down the CI/CD pipeline.