Add basic profile README and markdown validation workflow to .github#1
Conversation
Agent-Logs-Url: https://github.com/bminier/.github/sessions/b0bb254b-9a97-4e79-ab1c-a3471578e032 Co-authored-by: bminier <6529677+bminier@users.noreply.github.com>
|
@copilot Let's create a GitHub workflow that validates md files and is run on every PR and push into the dev branch. |
… to dev Agent-Logs-Url: https://github.com/bminier/.github/sessions/5e412d30-81a6-4683-ace4-6fda2ef08420 Co-authored-by: bminier <6529677+bminier@users.noreply.github.com>
Done! Added |
There was a problem hiding this comment.
Pull request overview
This PR replaces the repository profile README.md stub with a basic GitHub profile layout and adds a GitHub Actions workflow to lint Markdown files on pushes and PRs targeting the dev branch.
Changes:
- Expanded
README.mdwith an “About Me”, “Skills & Technologies”, and GitHub stats badge section. - Added
.github/workflows/markdown-lint.ymlto runmarkdownlint-cli2against all**/*.mdfiles onpush/pull_requesttodev.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds profile content sections and a GitHub stats badge |
| .github/workflows/markdown-lint.yml | Introduces CI workflow to lint Markdown files on dev branch activity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - 🔧 Problem Solving | ||
|
|
||
| ## GitHub Stats | ||
|
|
There was a problem hiding this comment.
This stats badge line is likely to violate markdownlint's default MD013 (line length) rule, which will cause the new markdown-lint workflow to fail since the repo doesn't include a markdownlint config overriding MD013. Consider adding a markdownlint config (e.g., relaxing/disable MD013) or reformatting the image URL (reference-style link) so it passes linting.
| <!-- markdownlint-disable-next-line MD013 --> |
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Run markdownlint | ||
| uses: DavidAnson/markdownlint-cli2-action@v17 |
There was a problem hiding this comment.
For supply-chain security, consider pinning GitHub Actions to a commit SHA (or at least a full-length immutable ref) instead of floating version tags like @v4 / @v17. This reduces the risk of a compromised tag updating the workflow unexpectedly; Dependabot can keep pinned SHAs updated.
| uses: actions/checkout@v4 | |
| - name: Run markdownlint | |
| uses: DavidAnson/markdownlint-cli2-action@v17 | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | |
| - name: Run markdownlint | |
| uses: DavidAnson/markdownlint-cli2-action@3c4f0b5c2fd6e64042fbaa2ee2e0235bf52c4a63 # v17 |
Add basic profile README and markdown validation workflow to .github
The
README.mdwas a two-line stub with no useful profile content. This PR also adds a GitHub Actions workflow to validate markdown files on every PR and push to thedevbranch.Changes
README.md: Replaced placeholder content with a standard GitHub profile layout:
github-readme-stats.github/workflows/markdown-lint.yml: New workflow that validates all*.mdfiles usingDavidAnson/markdownlint-cli2-action@v17, triggered onpushandpull_requestevents targeting thedevbranch.Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.