Skip to content

Commit 1dd28dd

Browse files
authored
Add Release Notes column to API reference versions table (#225)
The API reference landing page versions table had no link to per-version changelog/release notes. ## Changes - **`publish-documentation.yml`**: Added a "Release Notes" column to the generated "Released Versions" table; each entry links to the corresponding GitHub Release page (`releases/tag/v<version>`), which is already auto-populated from `CHANGELOG.md` by the release workflow. The generated table now looks like: | Version | Guide | API Reference | Release Notes | |---------|-------|---------------|---------------| | v1.0 (latest) | Guide | API Reference | [Release Notes](https://github.com/petesramek/polyline-algorithm-csharp/releases/tag/v1.0) |
1 parent e9e1420 commit 1dd28dd

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

.github/workflows/publish-documentation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,15 +151,15 @@ jobs:
151151
{
152152
echo "## Released Versions"
153153
echo ""
154-
echo "| Version | Guide | API Reference |"
155-
echo "|---------|-------|---------------|"
154+
echo "| Version | Guide | API Reference | Release Notes |"
155+
echo "|---------|-------|---------------|---------------|"
156156
for ver in $(echo "${{ steps.discover-versions.outputs.versions }}" | tr ',' '\n' | sort -Vr); do
157157
if [ "$ver" = "$latest" ]; then
158158
label="v${ver} (latest)"
159159
else
160160
label="v${ver}"
161161
fi
162-
echo "| ${label} | [Guide](${ver}/guide/getting-started.html) | [API Reference](${ver}/PolylineAlgorithm.html) |"
162+
echo "| ${label} | [Guide](${ver}/guide/getting-started.html) | [API Reference](${ver}/PolylineAlgorithm.html) | [Release Notes](https://github.com/petesramek/polyline-algorithm-csharp/releases/tag/v${ver}) |"
163163
done
164164
} > /tmp/versions_section.md
165165
awk '/{versions_section}/{while((getline line < "/tmp/versions_section.md") > 0) print line; close("/tmp/versions_section.md"); next} {print}' \

0 commit comments

Comments
 (0)