Skip to content

Commit 5c31647

Browse files
CopilotMalcolmnixon
Copilot
and
Malcolmnixon
authored
Add yamllint integration and standardize YAML formatting (#51)
* Initial plan * Add yamllint integration and fix all YAML formatting issues Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Fix trailing spaces in yamllint configuration file Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Extend line length limit to 120 characters and revert unnecessary line breaks Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Check all YAML files and fix additional GitHub config files Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 4bc3f2b commit 5c31647

File tree

14 files changed

+175
-96
lines changed

14 files changed

+175
-96
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Bug report issue template for VHDLTest
3+
# Used to collect structured information about bugs
14
name: 🐛 Bug Report
25
description: Report a bug or unexpected behavior in VHDLTest
36
title: "[Bug]: "
@@ -6,7 +9,8 @@ body:
69
- type: markdown
710
attributes:
811
value: |
9-
Thanks for taking the time to report a bug! Please fill out the form below to help us investigate and fix the issue.
12+
Thanks for taking the time to report a bug! Please fill out
13+
the form below to help us investigate and fix the issue.
1014
1115
- type: textarea
1216
id: description
@@ -113,7 +117,9 @@ body:
113117
id: terms
114118
attributes:
115119
label: Code of Conduct
116-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/demaconsulting/VHDLTest/blob/main/CODE_OF_CONDUCT.md)
120+
description: >
121+
By submitting this issue, you agree to follow our
122+
[Code of Conduct](https://github.com/demaconsulting/VHDLTest/blob/main/CODE_OF_CONDUCT.md)
117123
options:
118124
- label: I agree to follow this project's Code of Conduct
119125
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# GitHub issue template configuration
3+
# Controls issue creation and provides helpful links
14
blank_issues_enabled: false
25
contact_links:
36
- name: 💬 GitHub Discussions

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Feature request issue template for VHDLTest
3+
# Used to collect structured information about feature requests
14
name: ✨ Feature Request
25
description: Suggest a new feature or enhancement for VHDLTest
36
title: "[Feature]: "
@@ -6,7 +9,8 @@ body:
69
- type: markdown
710
attributes:
811
value: |
9-
Thanks for taking the time to suggest a feature! Please fill out the form below to help us understand your request.
12+
Thanks for taking the time to suggest a feature! Please fill
13+
out the form below to help us understand your request.
1014
1115
- type: textarea
1216
id: problem
@@ -83,7 +87,9 @@ body:
8387
id: terms
8488
attributes:
8589
label: Code of Conduct
86-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/demaconsulting/VHDLTest/blob/main/CODE_OF_CONDUCT.md)
90+
description: >
91+
By submitting this issue, you agree to follow our
92+
[Code of Conduct](https://github.com/demaconsulting/VHDLTest/blob/main/CODE_OF_CONDUCT.md)
8793
options:
8894
- label: I agree to follow this project's Code of Conduct
8995
required: true

‎.github/dependabot.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Dependabot configuration for VHDLTest
3+
# Manages dependencies for NuGet packages and GitHub Actions
14
version: 2
25
updates:
36
# Maintain dependencies for .NET / NuGet

‎.github/workflows/build.yaml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
# Reusable workflow for building VHDLTest artifacts
3+
# This workflow is called by other workflows to build the project
24
on:
35
workflow_call:
46
inputs:
@@ -15,9 +17,10 @@ on:
1517

1618
jobs:
1719
build:
20+
# Permissions for this job
1821
permissions:
19-
contents: read # To read repository contents
20-
pull-requests: write # To write pull requests analysis results and artifacts
22+
contents: read # To read repository contents
23+
pull-requests: write # To write pull requests analysis
2124

2225
runs-on: ${{ inputs.os }}
2326

‎.github/workflows/build_on_push.yaml‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
2+
# Main build workflow that runs on all pushes
3+
# This workflow performs quality checks, builds, and tests
24
name: Build
35

4-
on: [push, workflow_dispatch]
6+
on:
7+
push:
8+
workflow_dispatch:
59

610
jobs:
711
quality-checks:
@@ -29,11 +33,18 @@ jobs:
2933
config: .markdownlint.json
3034
globs: '**/*.md'
3135

36+
- name: YAML Lint
37+
uses: ibiqlik/action-yamllint@v3
38+
with:
39+
config_file: .yamllint.yaml
40+
file_or_dir: .
41+
3242
build:
3343
name: Build Artifacts
44+
# Permissions for this job
3445
permissions:
35-
contents: read # To read repository contents
36-
pull-requests: write # To write pull requests analysis results and artifacts
46+
contents: read # To read repository contents
47+
pull-requests: write # To write pull requests analysis
3748
uses: ./.github/workflows/build.yaml
3849
with:
3950
os: ubuntu-latest
@@ -43,17 +54,19 @@ jobs:
4354

4455
test-ghdl:
4556
name: Test on GHDL
57+
# Permissions for this job
4658
permissions:
47-
contents: read # To read repository contents
59+
contents: read # To read repository contents
4860
needs: build
4961
uses: ./.github/workflows/test_ghdl.yaml
5062
with:
5163
version: 0.0.0-run.${{ github.run_number }}
5264

5365
test-nvc:
5466
name: Test on NVC
67+
# Permissions for this job
5568
permissions:
56-
contents: read # To read repository contents
69+
contents: read # To read repository contents
5770
needs: build
5871
uses: ./.github/workflows/test_nvc.yaml
5972
with:

‎.github/workflows/release.yaml‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
# Release workflow for creating and publishing releases
3+
# This workflow is manually triggered
24
name: Release
35

46
on:
@@ -14,16 +16,17 @@ on:
1416
default: 'publish'
1517
type: choice
1618
options:
17-
- none
18-
- release
19-
- publish
19+
- none
20+
- release
21+
- publish
2022

2123
jobs:
2224
build:
2325
name: Build Artifacts
26+
# Permissions for this job
2427
permissions:
25-
contents: read # To read repository contents
26-
pull-requests: write # To write pull requests analysis results and artifacts
28+
contents: read # To read repository contents
29+
pull-requests: write # To write pull requests analysis
2730
uses: ./.github/workflows/build.yaml
2831
with:
2932
os: ubuntu-latest
@@ -33,25 +36,28 @@ jobs:
3336

3437
test-ghdl:
3538
name: Test on GHDL
39+
# Permissions for this job
3640
permissions:
37-
contents: read # To read repository contents
41+
contents: read # To read repository contents
3842
needs: build
3943
uses: ./.github/workflows/test_ghdl.yaml
4044
with:
4145
version: ${{ inputs.version }}
4246

4347
test-nvc:
4448
name: Test on NVC
49+
# Permissions for this job
4550
permissions:
46-
contents: read # To read repository contents
51+
contents: read # To read repository contents
4752
needs: build
4853
uses: ./.github/workflows/test_nvc.yaml
4954
with:
5055
version: ${{ inputs.version }}
5156

5257
release:
58+
# Permissions for this job
5359
permissions:
54-
contents: write # To create releases
60+
contents: write # To create releases
5561

5662
runs-on: ubuntu-latest
5763

‎.github/workflows/test_ghdl.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Test workflow for GHDL simulator
3+
# This workflow is called by other workflows to test on GHDL
14
name: Test on GHDL
25
on:
36
workflow_call:
@@ -8,8 +11,9 @@ on:
811

912
jobs:
1013
test-ghdl:
14+
# Permissions for this job
1115
permissions:
12-
contents: read # To read repository contents
16+
contents: read # To read repository contents
1317

1418
strategy:
1519
matrix:

‎.github/workflows/test_nvc.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Test workflow for NVC simulator
3+
# This workflow is called by other workflows to test on NVC
14
name: Test on NVC
25
on:
36
workflow_call:
@@ -8,8 +11,9 @@ on:
811

912
jobs:
1013
test-nvc:
14+
# Permissions for this job
1115
permissions:
12-
contents: read # To read repository contents
16+
contents: read # To read repository contents
1317

1418
strategy:
1519
matrix:

‎.yamllint.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# yamllint configuration for VHDLTest
3+
# This configuration defines the rules for YAML file linting
4+
5+
extends: default
6+
7+
rules:
8+
# Allow 'on:' in GitHub Actions workflows (not a boolean value)
9+
truthy:
10+
allowed-values: ['true', 'false', 'on', 'off']
11+
check-keys: true
12+
13+
# Allow longer lines for URLs and complex expressions
14+
line-length:
15+
max: 120
16+
level: error
17+
18+
# Ensure proper indentation
19+
indentation:
20+
spaces: 2
21+
indent-sequences: true
22+
23+
# Ensure proper comment formatting
24+
comments:
25+
min-spaces-from-content: 2

0 commit comments

Comments
 (0)