Skip to content

Commit 7fa82ec

Browse files
Fix install script issues and update documentation (#67)
* Prepare release 0.1.0 - Updated release notes with comprehensive feature documentation - Updated package metadata with detailed release notes - Version 0.1.0 includes initial release with all core functionality * Fix release workflow heredoc parsing issue - Use unique delimiter RELEASE_NOTES_DELIMITER instead of EOF - Prevents conflicts when release notes contain EOF string - Fixes GitHub Actions workflow parsing error * Fix install script issues and update documentation - Fix PowerShell syntax error in install.ps1 PATH variable reference - Update README.md to use correct 'dev' branch URLs instead of 'main' - Fix GitHub Actions release workflow heredoc parsing - Add missing newline to RELEASE_NOTES.md
1 parent 2bc5658 commit 7fa82ec

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

.github/workflows/release.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,11 @@ jobs:
9696
id: release_notes
9797
run: |
9898
if [ -f "RELEASE_NOTES.md" ]; then
99-
echo "notes<<EOF" >> $GITHUB_OUTPUT
100-
cat RELEASE_NOTES.md >> $GITHUB_OUTPUT
101-
echo "EOF" >> $GITHUB_OUTPUT
99+
{
100+
echo "notes<<RELEASE_NOTES_DELIMITER"
101+
cat RELEASE_NOTES.md
102+
echo "RELEASE_NOTES_DELIMITER"
103+
} >> $GITHUB_OUTPUT
102104
else
103105
echo "notes=Release ${{ steps.version.outputs.version }}" >> $GITHUB_OUTPUT
104106
fi

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,25 @@ link-validator --url https://example.com --output new-sitemap.md --diff old-site
4040
**Windows (PowerShell):**
4141
```powershell
4242
# Install to default location and add to PATH
43-
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.ps1 | iex
43+
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.ps1 | iex
4444
4545
# Install to custom location
46-
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.ps1 | iex -ArgumentList "-InstallPath", "C:\tools\linkvalidator"
46+
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.ps1 | iex -ArgumentList "-InstallPath", "C:\tools\linkvalidator"
4747
4848
# Install without adding to PATH
49-
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.ps1 | iex -ArgumentList "-SkipPath"
49+
irm https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.ps1 | iex -ArgumentList "-SkipPath"
5050
```
5151

5252
**Linux/macOS (Bash):**
5353
```bash
5454
# Install to default location and add to PATH
55-
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.sh | bash
55+
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.sh | bash
5656

5757
# Install to custom location
58-
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.sh | bash -s -- --dir ~/.local/bin
58+
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.sh | bash -s -- --dir ~/.local/bin
5959

6060
# Install without adding to PATH
61-
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.sh | bash -s -- --skip-path
61+
curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.sh | bash -s -- --skip-path
6262
```
6363

6464
### Option 2: Download Binary
@@ -107,7 +107,7 @@ The documentation includes ready-to-use examples for:
107107
```yaml
108108
# GitHub Actions
109109
- name: Install LinkValidator
110-
run: curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/main/install.sh | bash
110+
run: curl -fsSL https://raw.githubusercontent.com/Aaronontheweb/link-validator/dev/install.sh | bash
111111

112112
- name: Validate Links
113113
run: link-validator --url http://localhost:3000 --strict

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ LinkValidator is a fast, reliable CLI tool for crawling websites and validating
3636

3737
**Environment Variable Support:**
3838
- `LINK_VALIDATOR_MAX_EXTERNAL_RETRIES` - Configure max retry attempts
39-
- `LINK_VALIDATOR_RETRY_DELAY_SECONDS` - Configure retry delay timing
39+
- `LINK_VALIDATOR_RETRY_DELAY_SECONDS` - Configure retry delay timing

install.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ try {
163163
elseif (Test-Path ~/.bashrc) { "~/.bashrc" }
164164
else { "~/.profile" }
165165

166-
$PathLine = "export PATH=`"$InstallPath:`$PATH`""
166+
$PathLine = "export PATH=`"$InstallPath:`${PATH}`""
167167

168168
if (-not (Get-Content $ShellProfile -ErrorAction SilentlyContinue | Select-String -Pattern [regex]::Escape($InstallPath))) {
169169
Add-Content -Path $ShellProfile -Value $PathLine

0 commit comments

Comments
 (0)