Skip to content

Commit fa2e220

Browse files
committed
docs: enhance wheel installation instructions in release notes
1 parent 0678b70 commit fa2e220

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

.github/workflows/release.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,28 @@ jobs:
122122
echo "```" >> release_notes.md
123123
echo "" >> release_notes.md
124124
echo "Or install from the released wheel:" >> release_notes.md
125+
echo "" >> release_notes.md
126+
echo "1. Download the wheel file from the release assets" >> release_notes.md
127+
echo "2. Open a terminal/command prompt" >> release_notes.md
128+
echo "3. Navigate to the directory containing the downloaded wheel file" >> release_notes.md
129+
echo "4. Run the following command:" >> release_notes.md
130+
echo "```" >> release_notes.md
131+
echo "pip install easy_fossy-${{ steps.version.outputs.VERSION_CLEAN }}.whl" >> release_notes.md
132+
echo "```" >> release_notes.md
133+
echo "" >> release_notes.md
134+
echo "For example, if you downloaded the file to your Downloads folder on Windows:" >> release_notes.md
135+
echo "```" >> release_notes.md
136+
echo "cd ~/Downloads" >> release_notes.md
137+
echo "pip install easy_fossy-${{ steps.version.outputs.VERSION_CLEAN }}.whl" >> release_notes.md
138+
echo "```" >> release_notes.md
139+
echo "" >> release_notes.md
140+
echo "On macOS/Linux, if downloaded to the default download location:" >> release_notes.md
125141
echo "```" >> release_notes.md
142+
echo "cd ~/Downloads" >> release_notes.md
126143
echo "pip install easy_fossy-${{ steps.version.outputs.VERSION_CLEAN }}.whl" >> release_notes.md
127144
echo "```" >> release_notes.md
128145
echo "" >> release_notes.md
146+
echo "Note: The wheel file is cross-platform and works on Windows, macOS, and Linux." >> release_notes.md
129147
130148
cat release_notes.md
131149

0 commit comments

Comments
 (0)