-
Notifications
You must be signed in to change notification settings - Fork 219
ci: add markdownlint infrastructure #159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
b121070
ci: add markdownlint infrastructure (config, CI workflow, pre-commit)
scottschreckengaust 06f93d9
Merge branch 'main' into worktree-add-markdownlint
scottschreckengaust 21fea26
ci: fix MD041 in CODE_OF_CONDUCT.md, re-enable rule
scottschreckengaust 7a837ff
fix: resolve all markdownlint violations outside aidlc-rules/
scottschreckengaust cfaab5c
style: enforce MD060 aligned table style, fix 1645 violations
scottschreckengaust 797d82a
chore: improve cliff.toml template for markdownlint compliance
scottschreckengaust aeedd12
refactor: move aidlc-rules/ exceptions to per-directory config
scottschreckengaust 7df6691
Merge branch 'main' into worktree-add-markdownlint
scottschreckengaust de0f3b2
fix: align table pipes in ADMINISTRATIVE_GUIDE.md for MD060
scottschreckengaust 7cea1de
fix: resolve merge conflicts with main after security scanners PR
scoropeza 2f1b40d
fix: resolve markdownlint violations in DEVELOPERS_GUIDE security sca…
scoropeza 2798288
fix: add event_name to concurrency group key for consistency
scottschreckengaust 143e995
fix: add event_name to concurrency group keys for all workflows
scottschreckengaust 6f2ee2a
Merge branch 'main' into worktree-add-markdownlint
scottschreckengaust d5b7b50
fix: replace verbose deny-all permissions with permissions: {}
scottschreckengaust File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [ "main" ] | ||
| push: | ||
| branches: [ "main" ] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: {} | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| markdownlint: | ||
| name: Markdown Lint | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 #v6.0.1 | ||
| - uses: DavidAnson/markdownlint-cli2-action@ce4853d43830c74c1753b39f3cf40f71c2031eb9 #v23.0.0 | ||
| with: | ||
| globs: "**/*.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # markdownlint-cli2 configuration | ||
| # https://github.com/DavidAnson/markdownlint-cli2 | ||
| # Run: npx markdownlint-cli2 "**/*.md" | ||
| # Fix: npx markdownlint-cli2 --fix "**/*.md" | ||
|
|
||
| config: | ||
| # ============================================================ | ||
| # PERMANENTLY DISABLED — conflict with project documentation style | ||
| # ============================================================ | ||
|
|
||
| # Line-length — long URLs, tables, code examples, ASCII diagrams | ||
| MD013: false | ||
|
|
||
| # Inline HTML — <img> tags for screenshots/badges in README | ||
| MD033: false | ||
|
|
||
| # Duplicate headings — section names repeat across platform guides | ||
| MD024: false | ||
|
|
||
| # Emphasis as heading — bold text used as sub-labels in lists | ||
| MD036: false | ||
|
|
||
| # ============================================================ | ||
| # STYLE SETTINGS | ||
| # ============================================================ | ||
|
|
||
| # Tables must use aligned column style (pipes vertically aligned) | ||
| MD060: | ||
| style: "aligned" | ||
|
|
||
| # Ignore generated/vendored/test fixture files | ||
| ignores: | ||
| - "node_modules/**" | ||
| - ".claude/**" | ||
| - "scripts/aidlc-evaluator/test_cases/**" | ||
| # CHANGELOG.md is auto-generated by git-cliff (cliff.toml controls its format). | ||
| # git-cliff postprocessors run per-body so inter-body spacing and trailing | ||
| # whitespace cannot be fully controlled via template alone. | ||
| - "CHANGELOG.md" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| repos: | ||
| - repo: https://github.com/DavidAnson/markdownlint-cli2 | ||
| rev: v0.22.0 | ||
| hooks: | ||
| - id: markdownlint-cli2 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| ## Code of Conduct | ||
| # Code of Conduct | ||
|
|
||
| This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
| [email protected] with any additional questions or comments. | ||
| <[email protected]> with any additional questions or comments. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ AI-DLC rules live in `aidlc-rules/aws-aidlc-rule-details/`. When contributing: | |
| ### Rule Structure | ||
|
|
||
| Rules are organized by phase: | ||
|
|
||
| - `common/` - Shared guidance across all phases | ||
| - `inception/` - Planning and architecture rules | ||
| - `construction/` - Design and implementation rules | ||
|
|
@@ -33,6 +34,7 @@ Test your rule changes with at least one supported platform (Amazon Q Developer, | |
| Use GitHub issues to report bugs or suggest features. Before filing, check existing issues to avoid duplicates. | ||
|
|
||
| Include: | ||
|
|
||
| - Which rule or stage is affected | ||
| - Expected vs actual behavior | ||
| - The platform/model you tested with | ||
|
|
@@ -56,7 +58,7 @@ To submit: | |
|
|
||
| This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
|
|
||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [email protected] with any additional questions or comments. | ||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact <[email protected]> with any additional questions or comments. | ||
|
|
||
| ## Security Issue Notifications | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.