Skip to content

Commit 0f79cd8

Browse files
authored
improve body of weekly build (#3901)
1 parent 94e783e commit 0f79cd8

File tree

1 file changed

+47
-4
lines changed

1 file changed

+47
-4
lines changed

.github/workflows/weekly.yml

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ jobs:
118118
BASE_VERSION=$(grep '__version__ = ' altair/__init__.py | sed 's/__version__ = "\(.*\)"/\1/')
119119
DATE=$(date +%Y%m%d)
120120
COMMIT=$(git rev-parse --short HEAD)
121+
COMMIT_SHA=$(git rev-parse HEAD)
121122
# PEP 440 compliant dev version - handle cases where base version already has 'dev'
122123
if [[ "$BASE_VERSION" == *"dev" ]]; then
123124
# If base version already has 'dev', replace it with proper dev format
@@ -131,6 +132,7 @@ jobs:
131132
echo "Generated tag name: ${TAG_NAME}"
132133
echo "version=${VERSION}" >> $GITHUB_OUTPUT
133134
echo "tag_name=${TAG_NAME}" >> $GITHUB_OUTPUT
135+
echo "commit_sha=${COMMIT_SHA}" >> $GITHUB_OUTPUT
134136
- name: Update version files
135137
run: |
136138
# Update version in __init__.py
@@ -199,13 +201,54 @@ jobs:
199201
tag_name: ${{ steps.version.outputs.tag_name }}
200202
name: Weekly Build ${{ steps.version.outputs.version }}
201203
body: |
202-
Weekly pre-release build of Altair
204+
## Weekly Pre-Release Build of Altair
203205
204-
**Version:** ${{ steps.version.outputs.version }}
205-
**Tag:** ${{ steps.version.outputs.tag_name }}
206+
This is a pre-release version for testing purposes.
207+
208+
### Build Information
209+
210+
**Version:** ${{ steps.version.outputs.version }}
211+
**Tag:** ${{ steps.version.outputs.tag_name }}
206212
**Previous Weekly Tag:** ${{ needs.check-changes.outputs.last-weekly-tag || 'None (first build)' }}
207213
208-
This is a pre-release version for testing purposes.
214+
## Installation
215+
216+
### From GitHub Repository (direct install)
217+
218+
Install directly from the tagged commit without downloading the wheel:
219+
220+
**Command line (pip or uv):**
221+
```bash
222+
pip install git+https://github.com/${{ github.repository }}.git@${{ steps.version.outputs.tag_name }}
223+
# or
224+
uv pip install git+https://github.com/${{ github.repository }}.git@${{ steps.version.outputs.tag_name }}
225+
```
226+
227+
**Add to pyproject.toml (pip/uv):**
228+
```toml
229+
[project]
230+
dependencies = [
231+
"altair @ git+https://github.com/${{ github.repository }}.git@${{ steps.version.outputs.tag_name }}",
232+
]
233+
```
234+
235+
**Add to pixi.toml (pixi):**
236+
```toml
237+
[pypi-dependencies]
238+
altair = { git = "https://github.com/${{ github.repository }}.git", rev = "${{ steps.version.outputs.tag_name }}" }
239+
```
240+
241+
### From GitHub Release (manual download)
242+
243+
Download the wheel file from the assets below and install:
244+
245+
```bash
246+
pip install altair-${{ steps.version.outputs.version }}-py3-none-any.whl
247+
```
248+
249+
## Testing & Feedback
250+
251+
**Please note:** This is a testing version. If you encounter any issues or unexpected behavior, we would greatly appreciate if you [open an issue](https://github.com/${{ github.repository }}/issues) to report it. Your feedback helps improve Altair!
209252
draft: false
210253
prerelease: true
211254
files: |

0 commit comments

Comments
 (0)