Skip to content

Commit 331d84a

Browse files
author
Jason Walker
committed
fix: resolve all markdown linting failures
- Add blank lines around headings, code blocks, lists, and tables (MD022, MD031, MD032, MD058) - Fix line length violations by breaking long lines (MD013) - Add language specifiers to code blocks (MD040) - Convert emphasis to proper headings (MD036) - Add missing trailing newlines (MD047) - Fix ordered list numbering consistency (MD029) - Fix strong style inconsistencies (MD050) Addresses all markdown linting issues found in CI job run: https://github.com/desktophero/github-copilot-cli/actions/runs/18057131112/job/51388426631 This should make the 'Lint and Format Check' job pass successfully.
1 parent 32b3638 commit 331d84a

9 files changed

Lines changed: 362 additions & 186 deletions

EXAMPLES.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Practical Examples
22

3-
> **⚠️ MIGRATION NOTICE**: These examples have been updated for the new standalone GitHub Copilot CLI (`copilot`), not the deprecated `gh copilot` extension.
3+
> **⚠️ MIGRATION NOTICE**: These examples have been updated for the new standalone GitHub
4+
> Copilot CLI (`copilot`), not the deprecated `gh copilot` extension.
45
56
## Common Development Scenarios
67

@@ -307,4 +308,6 @@ copilot --version
307308
copilot --banner # First launch with banner
308309
```
309310

310-
> **⚠️ Note**: Many advanced features from the old CLI are being reimplemented. Check the [official repository](https://github.com/github/copilot-cli) for the latest feature updates and migration guides.
311+
> **⚠️ Note**: Many advanced features from the old CLI are being reimplemented. Check the
312+
> [official repository](https://github.com/github/copilot-cli) for the latest feature updates and
313+
> migration guides.

docs/branch-protection-setup.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Run the provided script to automatically configure branch protection:
88

99
```bash
1010
./configure-branch-protection.sh
11-
```
11+
```text
1212
1313
This script will:
14+
1415
- ✅ Create a `develop` branch (if it doesn't exist)
1516
- ✅ Configure branch protection rules for `main` branch
1617
- ✅ Optionally protect `develop` branch
@@ -32,6 +33,7 @@ Click "Add rule" and configure:
3233
**Branch name pattern:** `main`
3334
3435
**Protection settings:**
36+
3537
- ✅ Require a pull request before merging
3638
- ✅ Require approvals: 1
3739
- ✅ Dismiss stale PR approvals when new commits are pushed
@@ -42,7 +44,7 @@ Click "Add rule" and configure:
4244
- ✅ Require branches to be up to date before merging
4345
- **Required status checks:**
4446
- `spell-check`
45-
- `security-scan`
47+
- `security-scan`
4648
- `lint-and-format`
4749
- `docs-check`
4850
- `build-validation`
@@ -58,6 +60,7 @@ Click "Add rule" and configure:
5860
Go to: `https://github.com/YOUR_USERNAME/REPO_NAME/settings/security_analysis`
5961
6062
Enable:
63+
6164
- ✅ Dependabot alerts
6265
- ✅ Dependabot security updates
6366
- ✅ Secret scanning alerts (if available for your account type)
@@ -87,7 +90,7 @@ git push origin feature/your-feature-name
8790
# - Request review from team member
8891
# - Address any feedback
8992
# - Merge when approved and checks pass
90-
```
93+
```text
9194
9295
### Bug Fix Workflow
9396
@@ -106,35 +109,40 @@ git commit -sS -m "fix(scope): description of fix"
106109
# 4. Push and create PR
107110
git push origin fix/issue-description
108111
# Create PR through GitHub web interface
109-
```
112+
```text
110113
111114
## CI/CD Pipeline Status Checks
112115
113116
The following checks must pass before merging:
114117
115118
### ✅ spell-check
119+
116120
- Validates spelling in documentation files
117121
- Uses cspell with custom dictionary
118122
- Fails on unknown words or typos
119123
120124
### ✅ security-scan
125+
121126
- Runs Grype vulnerability scanner
122127
- Scans for known vulnerabilities in dependencies
123128
- Uploads results to GitHub Security tab
124129
- Fails on medium+ severity findings
125130
126131
### ✅ lint-and-format
132+
127133
- Validates markdown formatting
128134
- Checks for trailing whitespace
129135
- Validates YAML syntax
130136
- Ensures consistent documentation style
131137
132138
### ✅ docs-check
139+
133140
- Verifies required documentation files exist
134141
- Checks for broken internal links
135142
- Validates documentation completeness
136143
137144
### ✅ build-validation
145+
138146
- Validates shell script syntax
139147
- Checks file permissions
140148
- Ensures executables are properly configured
@@ -144,69 +152,81 @@ The following checks must pass before merging:
144152
### CI Checks Failing
145153
146154
**Spell Check Issues:**
155+
147156
```bash
148157
# Run locally to see issues
149158
npm install -g cspell
150159
cspell "**/*.md" --config .cspell.json
151160
152161
# Add words to .cspell.json if needed
153-
```
162+
```text
154163
155164
**Security Scan Issues:**
165+
156166
- Check Security tab for vulnerability details
157167
- Update dependencies to fix known issues
158168
- Consider suppressing false positives if necessary
159169
160170
**Lint Issues:**
171+
161172
```bash
162173
# Run markdown linter locally
163174
npm install -g markdownlint-cli
164175
markdownlint "**/*.md" --config .markdownlint.json
165-
```
176+
```text
166177
167178
### Branch Protection Issues
168179
169180
**Can't push to main:**
181+
170182
- This is expected! Create a feature branch instead
171183
- Use PR workflow for all changes
172184
173185
**Status checks not appearing:**
186+
174187
- Ensure workflows have run at least once
175188
- Check Actions tab for workflow status
176189
- Verify workflow names match protection settings
177190
178191
**Admin bypass:**
192+
179193
- Even admins must follow the workflow
180194
- This ensures consistent code quality
181195
- Use "Include administrators" setting to enforce
182196
183197
## Benefits of This Setup
184198
185199
✅ **Quality Assurance**
200+
186201
- All code reviewed before merging
187202
- Automated testing and validation
188203
- Consistent formatting and style
189204
190205
✅ **Security**
206+
191207
- Vulnerability scanning on every change
192208
- Secret detection prevents credential leaks
193209
- Dependency monitoring for supply chain security
194210
195211
✅ **Collaboration**
212+
196213
- Clear contribution guidelines
197214
- Standardized PR process
198215
- Documentation requirements enforced
199216
200217
✅ **Maintainability**
218+
201219
- Linear git history
202220
- Conventional commit messages
203221
- Comprehensive changelog tracking
204222
205223
✅ **Automation**
224+
206225
- Reduces manual oversight burden
207226
- Consistent quality checks
208227
- Automated security monitoring
209228
210229
---
211230
212-
This branch protection setup ensures high code quality while maintaining development velocity through automation and clear processes.
231+
This branch protection setup ensures high code quality while maintaining development velocity
232+
through automation and clear processes.

0 commit comments

Comments
 (0)