Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(workflows): use uv to install dependencies in main workflow run #6

Closed
wants to merge 3 commits into from
Closed

ci(workflows): use uv to install dependencies in main workflow run #6

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22691d0
ci(workflows): use uv to install dependencies in main workflow run
arunanshub Aug 25, 2024
555f01a
ci(workflows): fix workflow pdm export
arunanshub Aug 25, 2024
7728ac7
ci(workflow): remove newline in command
arunanshub Aug 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,31 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Install uv installer 🌞
run: pipx install uv

- name: Get uv cache directory
id: uv-cache
run: |
echo "cache-dir=$(uv cache dir)\n" >> $GITHUB_OUTPUT

- name: Setup uv Cache
uses: actions/cache@v4
with:
key: uv-${{ runner.os }}-${{ matrix.python-version }}-pdm
path: ${{ steps.uv-cache.outputs.cache-dir }}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix shell script issues and approve caching setup.

The caching mechanism is correctly set up using actions/cache. However, the script has issues that need addressing:

  • Use printf instead of echo to ensure escape sequences are handled correctly.
  • Ensure variables are double-quoted to prevent globbing and word splitting.

Apply this diff to fix the script issues:

- echo "cache-dir=$(uv cache dir)\n" >> $GITHUB_OUTPUT
+ printf "cache-dir=%s\n" "$(uv cache dir)" >> $GITHUB_OUTPUT
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Get uv cache directory
id: uv-cache
run: |
echo "cache-dir=$(uv cache dir)\n" >> $GITHUB_OUTPUT
- name: Setup uv Cache
uses: actions/cache@v4
with:
key: uv-${{ runner.os }}-${{ matrix.python-version }}-pdm
path: ${{ steps.uv-cache.outputs.cache-dir }}
- name: Get uv cache directory
id: uv-cache
run: |
printf "cache-dir=%s\n" "$(uv cache dir)" >> $GITHUB_OUTPUT
- name: Setup uv Cache
uses: actions/cache@v4
with:
key: uv-${{ runner.os }}-${{ matrix.python-version }}-pdm
path: ${{ steps.uv-cache.outputs.cache-dir }}
Tools
actionlint

70-70: shellcheck reported issue in this script: SC2028:info:1:6: echo may not expand escape sequences. Use printf

(shellcheck)

70-70: shellcheck reported issue in this script: SC2086:info:1:39: Double quote to prevent globbing and word splitting

(shellcheck)


- name: Setup PDM 📦
uses: pdm-project/[email protected]
id: setup-pdm
with:
cache: true
python-version: ${{ matrix.python-version }}

- name: Install Python Dependencies 📦
run: pdm install
- name: Install Python Dependencies (using UV) 📦
run: |
pdm export > requirements.txt
uv pip install -r requirements.txt --editable .

- name: Check Python Formatting 🖌️
run: pdm run ruff check .
Expand All @@ -89,9 +105,6 @@ jobs:
parallel: true
flag-name: run-${{ matrix.os }}-python-${{ matrix.python-version }}

- name: Install uv installer 🌞
run: pipx install uv

- name: Build wheels 🛞
uses: pypa/[email protected]
env:
Expand Down
Loading