Skip to content

Commit 058817a

Browse files
committed
fix: resolve MarkdownLint violations in documentation
- Add blank lines around lists in package-manager-setup.md - Add blank lines around fenced code blocks - Specify language for fenced code blocks (text for directory structure) - Add blank lines around fenced code blocks in README.md Resolves all MD031, MD032, and MD040 violations for consistent Markdown formatting.
1 parent f48b0eb commit 058817a

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,13 @@ task ci
9090
#### Package Managers (Recommended)
9191

9292
**Windows (Chocolatey):**
93+
9394
```powershell
9495
choco install dotnetapidiff
9596
```
9697

9798
**macOS/Linux (Homebrew):**
99+
98100
```bash
99101
brew install dotnetapidiff
100102
```

docs/package-manager-setup.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This document explains how to set up automated publishing to Chocolatey and Home
55
## Overview
66

77
The release workflow automatically builds and publishes packages to:
8+
89
- **Chocolatey** (Windows package manager)
910
- **Homebrew** (macOS/Linux package manager)
1011

@@ -31,6 +32,7 @@ The following secrets must be configured in the GitHub repository settings:
3132
- Package ID: `dotnetapidiff`
3233

3334
3. **Configure GitHub Secret**:
35+
3436
```bash
3537
# In GitHub repository settings > Secrets and variables > Actions
3638
# Add new repository secret:
@@ -41,10 +43,12 @@ The following secrets must be configured in the GitHub repository settings:
4143
#### Homebrew Setup
4244

4345
Homebrew publishing is currently handled by generating an updated formula that can be:
46+
4447
1. **Submitted to homebrew-core** (requires community approval)
4548
2. **Published to a custom tap** (immediate publishing)
4649

4750
For custom tap approach:
51+
4852
1. Create a repository named `homebrew-dotnetapidiff`
4953
2. The workflow generates the updated formula as an artifact
5054
3. Manually or automatically commit the formula to the tap repository
@@ -54,13 +58,15 @@ For custom tap approach:
5458
### Chocolatey Publishing
5559

5660
The workflow automatically:
61+
5762
1. Builds Windows x64 and ARM64 binaries
5863
2. Calculates SHA256 checksums
5964
3. Creates a Chocolatey package (.nupkg)
6065
4. Publishes to Chocolatey Community using the API key
6166

6267
**Package Structure:**
63-
```
68+
69+
```text
6470
dotnetapidiff/
6571
├── tools/
6672
│ ├── chocolateyinstall.ps1 # Installation script
@@ -72,12 +78,14 @@ dotnetapidiff/
7278
### Homebrew Formula
7379

7480
The workflow automatically:
81+
7582
1. Downloads all platform binaries (macOS/Linux, x64/ARM64)
7683
2. Calculates SHA256 checksums for each platform
7784
3. Generates an updated Homebrew formula with correct URLs and checksums
7885
4. Uploads the formula as a build artifact
7986

8087
**Formula Features:**
88+
8189
- Platform detection (macOS/Linux, Intel/ARM)
8290
- Automatic binary selection based on platform
8391
- SHA256 verification

0 commit comments

Comments
 (0)