Skip to content

Improve quality checks with GitHub Actions and standardized configuration#41

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/improve-quality-checks
Dec 27, 2025
Merged

Improve quality checks with GitHub Actions and standardized configuration#41
Malcolmnixon merged 4 commits intomainfrom
copilot/improve-quality-checks

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

Modernizes quality checks by replacing npm-based tooling with GitHub Actions and standardizing linter configurations.

Changes

  • Workflow updates (build_on_push.yaml):

    • Replace markdownlint-cli with DavidAnson/markdownlint-cli2-action@v22
    • Replace cspell with streetsidesoftware/cspell-action@v8
    • Add ibiqlik/action-yamllint@v3 for YAML validation
    • Remove Node.js setup step
  • Configuration standardization:

    • Simplify .markdownlint.json to DemaConsulting standard (MD003: atx, MD007: indent 2, MD013: 120 chars)
    • Add .yamllint.yaml with exact specification from issue (allows on: keyword, 120 char limit, proper indentation rules)
  • YAML formatting fixes:

    • Format spdx-workflow.yaml to comply with yamllint rules (add document start, fix indentation)
    • Remove trailing spaces in .github/dependabot.yml
    • Remove trailing spaces in .github/workflows/weekly-maintenance.yml
    • Remove trailing spaces in .github/ISSUE_TEMPLATE/bug_report.yml
  • Markdown fixes:

    • Add blank lines around lists in .github/agents/README.md (MD032)
    • Wrap long line in .github/ISSUE_TEMPLATE/bug_report.yml (line-length)
  • Dictionary update:

    • Add yamllint to .cspell.json dictionary

Validation

All quality checks pass:

markdownlint-cli2 "**/*.md"     # 0 errors
cspell "**/*.{md,cs}"           # 0 issues  
yamllint -c .yamllint.yaml .    # 0 errors (warnings only)
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Improve Quality Checks</issue_title>
<issue_description>### Problem Statement

The project should improve quality checks

Proposed Solution

The proposed solution includes:

  1. Modify the build_on_push.yaml 'quality-checks' job to run markdownlint using DavidAnson/markdownlint-cli2-action@v22
  2. Modify the build_on_push.yaml 'quality-checks' job to run cspell using streetsidesoftware/cspell-action@v8
  3. Add yamllint checking to the build_on_push.yaml 'quality-checks' job using ibiqlik/action-yamllint@v3
  4. Update the .markdownlint.json file to comply with DemaConsulting standard formatting
  5. Fix any issues found by the changes

Alternatives Considered

No response

Usage Examples

Benefits

Improved file consistency

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

The .markdownlint.json should be modified to:

{
  "default": true,
  "MD003": { "style": "atx" },
  "MD007": { "indent": 2 },
  "MD013": { "line_length": 120 },
  "MD033": false,
  "MD041": false
}

The .yamllint.yaml file should be:

---
# yamllint configuration for TestResults
# This configuration defines the rules for YAML file linting

extends: default

rules:
  # Allow 'on:' in GitHub Actions workflows (not a boolean value)
  truthy:
    allowed-values: ['true', 'false', 'on', 'off']
    check-keys: true

  # Allow longer lines for URLs and complex expressions
  line-length:
    max: 120
    level: error

  # Ensure proper indentation
  indentation:
    spaces: 2
    indent-sequences: true

  # Ensure proper comment formatting
  comments:
    min-spaces-from-content: 2

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits December 27, 2025 16:35
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve quality checks in build configuration Improve quality checks with GitHub Actions and standardized configuration Dec 27, 2025
Copilot AI requested a review from Malcolmnixon December 27, 2025 16:37
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review December 27, 2025 16:45
@Malcolmnixon Malcolmnixon merged commit 723af0f into main Dec 27, 2025
9 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/improve-quality-checks branch December 27, 2025 16:46
Malcolmnixon added a commit that referenced this pull request Mar 22, 2026
#47, #50#51) (#122)

* Initial plan

* Sync with TemplateDotNetLibrary: agent renames, config YAML formats, lint improvements

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TestResults/sessions/6cc889a2-a7ef-4630-8a34-607c27342a46

* chore: sync with TemplateDotNetLibrary PR #47 and #50

- Rename docs subdirectories to template naming convention:
  - buildnotes/ -> build_notes/
  - quality/ -> code_quality/
  - requirements/ -> requirements_doc/
  - tracematrix/ -> requirements_report/
  - reviewplan/ -> code_review_plan/
  - reviewreport/ -> code_review_report/
- Remove docs/justifications/ (merged into requirements_doc/)
- Update all definition.yaml files for renamed directories
- Update code_review_plan/introduction.md to add YAML config scope
- Add platform-requirements.yaml for OS platform requirements
- Add ReviewMark OTS requirement to ots-software.yaml
- Include platform-requirements.yaml in requirements.yaml
- Update build.yaml: doc paths, build_notes.md, reviewmark TODO
- Update release.yaml: build_notes.md references
- Update .gitignore with template patterns
- Update .reviewmark.yaml with improved header comments
- Update .github/pull_request_template.md: use lint.sh
- Update .cspell.yaml: remove reqstream, add build_notes
- Remove test/AssemblyInfo.cs (per template PR #50)
- Update docs/guide/guide.md: inline Continuous Compliance link
- Update AGENTS.md: expanded agent selection and quality gate docs
- Update all 7 agent files with enhanced template content

* refactor: restructure reqstream files to per-unit and per-OTS-tool YAML files

* refactor: split design docs per class, untrack package-lock.json

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TestResults/sessions/44cf4b76-f072-4ec1-bf10-741eeae60682

* ci: replace individual lint actions with lint.sh script in quality-checks job

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TestResults/sessions/e457826c-4ee7-414e-a620-d3de14e17e49

* chore: pin cspell and markdownlint-cli2 to exact versions in package.json

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TestResults/sessions/1de043c9-2b2b-42eb-a26d-8ce61fafd527

* fix: correct XML doc comment indentation in TrxSerializer.cs (dotnet format)

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/TestResults/sessions/7ca2a48a-e2fe-49db-adab-37108b8ecf7a

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Improve Quality Checks

2 participants