Skip to content

Commit

Permalink
Add GH action for build and uploading wheel
Browse files Browse the repository at this point in the history
This also involves creating a simple test to make sure the tag and the
version in package.json match.
  • Loading branch information
xofbd committed Mar 21, 2024
1 parent 0885885 commit dc941f5
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 144 deletions.
181 changes: 37 additions & 144 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,153 +1,46 @@
name: Build

on:
push:
branches: main
pull_request:
branches: '*'
on: [push]

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Install dependencies
run: python -m pip install -U "jupyterlab>=4.0.0,<5"

- name: Lint the extension
run: |
set -eux
jlpm
jlpm run lint:check
- name: Test the extension
run: |
set -eux
jlpm run test
- name: Build the extension
run: |
set -eux
python -m pip install .[test]
jupyter labextension list
jupyter labextension list 2>&1 | grep -ie "jupyterlab_custom_order.*OK"
python -m jupyterlab.browser_check
- name: Package the extension
run: |
set -eux
pip install build
python -m build
pip uninstall -y "jupyterlab_custom_order" jupyterlab
- name: Upload extension packages
uses: actions/upload-artifact@v3
with:
name: extension-artifacts
path: dist/jupyterlab_custom_order*
if-no-files-found: error

test_isolated:
needs: build
runs-on: ubuntu-latest

steps:
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
architecture: 'x64'
- uses: actions/download-artifact@v3
with:
name: extension-artifacts
- name: Install and Test
run: |
set -eux
# Remove NodeJS, twice to take care of system and locally installed node versions.
sudo rm -rf $(which node)
sudo rm -rf $(which node)
pip install "jupyterlab>=4.0.0,<5" jupyterlab_custom_order*.whl
jupyter labextension list
jupyter labextension list 2>&1 | grep -ie "jupyterlab_custom_order.*OK"
python -m jupyterlab.browser_check --no-browser-test
integration-tests:
name: Integration tests
needs: build
runs-on: ubuntu-latest

env:
PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Download extension package
uses: actions/download-artifact@v3
with:
name: extension-artifacts

- name: Install the extension
run: |
set -eux
python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_custom_order*.whl
- name: Install dependencies
working-directory: ui-tests
env:
YARN_ENABLE_IMMUTABLE_INSTALLS: 0
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
run: jlpm install

- name: Set up browser cache
uses: actions/cache@v3
with:
path: |
${{ github.workspace }}/pw-browsers
key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}

- name: Install browser
run: jlpm playwright install chromium
working-directory: ui-tests

- name: Execute integration tests
working-directory: ui-tests
run: |
jlpm playwright test
- name: Upload Playwright Test report
if: always()
uses: actions/upload-artifact@v3
with:
name: jupyterlab_custom_order-playwright-tests
path: |
ui-tests/test-results
ui-tests/playwright-report
check_links:
name: Check Links
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v3
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
- name: Install build requirements
run: |
sudo apt-get update && sudo apt-get install -y jq nodejs
- name: Build wheel
run: |
make build-wheel
- name: Test tag and version consistency
id: test_consistency
if: startsWith(github.ref, 'refs/tags/')
run: |
tests/test-version-tag
echo "VERSION=$(jq -r .version package.json)" >> "$GITHUB_OUTPUT"
- name: Create release
id: create_release
if: startsWith(github.ref, 'refs/tags/v') && steps.test_consistency.outcome == 'success'
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref_name }}
release_name: Version ${{ github.ref_name }}
draft: false
prerelease: false
- name: Upload release wheel
id: upload_release
if: steps.create_release.outcome == 'success'
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: dist/jupyterlab_custom_order-${{ steps.test_consistency.outputs.VERSION }}-py3-none-any.whl
asset_name: jupyterlab_custom_order-${{ steps.test_consistency.outputs.VERSION }}-py3-none-any.whl
asset_content_type: application/whl
14 changes: 14 additions & 0 deletions tests/test-version-tag
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/bash

TAG="$(git tag --contains HEAD)"
VERSION=v"$(jq -r .version package.json)"

if [[ "$TAG" == "$VERSION" ]]; then
echo "Tag and version in package.json match!"
exit 0
else
echo "Tag and version in package.json don't match!"
echo "Tag: "$TAG""
echo "Version: "$VERSION""
exit 1
fi

0 comments on commit dc941f5

Please sign in to comment.