Merge pull request #474 from shangyian/release-management

Align dependency management + workflows for publishing and releasing
DataJunction · Apr 27, 2023 · da3abc6 · da3abc6
2 parents 109447d + a6aa216
commit da3abc6
Show file tree

Hide file tree

Showing 24 changed files with 4,394 additions and 2,188 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,85 @@
+name: Release
+on:
+  workflow_dispatch:
+    inputs:
+      library:
+        type: choice
+        description: Which library to bump
+        required: true
+        options:
+          - server
+          - client
+      bump:
+        type: choice
+        description: Hatch version bump rule
+        required: true
+        options:
+          - release
+          - major
+          - minor
+          - patch
+          - alpha
+          - beta
+          - rc
+          - post
+          - dev
+
+jobs:
+  publish:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10']
+    runs-on: 'ubuntu-latest'
+    defaults:
+      run:
+        working-directory: ${{ github.event.inputs.library == 'server' && '.' || './client/python' }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Hatch
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+
+      - uses: pdm-project/setup-pdm@v3
+        name: Setup PDM
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          prerelease: true
+          enable-pep582: true
+
+      - name: Configure Git
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "<>"
+
+      - name: Bump release version with poetry and tag
+        run: |
+          hatch version ${{ github.event.inputs.bump }}
+          export NEW_VERSION=v$(hatch version)
+          export LIBRARY=${{ github.event.inputs.library }}
+          git commit -am "Bumping $LIBRARY to version $NEW_VERSION"
+          git tag -a $NEW_VERSION -m $NEW_VERSION
+          git push origin $NEW_VERSION
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPO_SCOPED_TOKEN }}
+
+      - name: Publish to pypi
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          hatch build
+          hatch publish
+
+      - name: Create Github release
+        run: |
+          gh release create $(hatch version) --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPO_SCOPED_TOKEN }}
diff --git a/.github/workflows/test-client.yml b/.github/workflows/test-client.yml
@@ -0,0 +1,45 @@
+name: Run tests for DJ
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.8', '3.9', '3.10']
+
+    defaults:
+      run:
+        working-directory: './client/python'
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: pdm-project/setup-pdm@v3
+        name: Setup PDM
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          prerelease: true
+          enable-pep582: true
+      - name: Install dependencies
+        run: pdm install
+      - name: Linters
+        run: |
+          pdm run pre-commit run --all-files
+
+      - name: Test DJ ${{ matrix.library }} with pytest
+        run: |
+          export module=${{ matrix.library == 'server' && 'dj' || 'datajunction' }}
+          pdm run pytest --cov-fail-under=100 --cov=$module -vv tests/ --doctest-modules $module --without-integration --without-slow-integration
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,46 @@
+name: Run tests for DJ
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.8', '3.9', '3.10']
+        library: ['client', 'server']
+
+    defaults:
+      run:
+        working-directory: ${{ matrix.library == 'server' && '.' || './client/python' }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: pdm-project/setup-pdm@v3
+        name: Setup PDM
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          prerelease: true
+          enable-pep582: true
+      - name: Install dependencies
+        run: pdm install
+      - name: Linters
+        run: |
+          pdm run pre-commit run --all-files
+
+      - name: Test DJ ${{ matrix.library }} with pytest
+        run: |
+          export module=${{ matrix.library == 'server' && 'dj' || 'datajunction' }}
+          pdm run pytest --cov-fail-under=100 --cov=$module -vv tests/ --doctest-modules $module --without-integration --without-slow-integration
diff --git a/.gitignore b/.gitignore
@@ -114,3 +114,4 @@ ENV/
 
 # MacOS
 .DS_Store
+.pdm-python
diff --git a/CHANGELOG.rst → CHANGELOG.md b/CHANGELOG.rst → CHANGELOG.md
diff --git a/Makefile b/Makefile
@@ -17,11 +17,11 @@ docker-build:
 docker-run:
 	docker compose up
 
-test: pyenv
-	pytest --cov=dj --cov-report=html -vv tests/ --doctest-modules dj --without-integration --without-slow-integration ${PYTEST_ARGS}
+test:
+	pdm run pytest --cov=dj --cov-report=html -vv tests/ --doctest-modules dj --without-integration --without-slow-integration ${PYTEST_ARGS}
 
-integration: pyenv
-	pytest --cov=dj -vv tests/ --doctest-modules dj --with-integration --with-slow-integration
+integration:
+	pdm run pytest --cov=dj -vv tests/ --doctest-modules dj --with-integration --with-slow-integration
 
 clean:
 	pyenv virtualenv-delete dj
@@ -30,16 +30,16 @@ spellcheck:
 	codespell -L froms -S "*.json" dj docs/*rst tests templates
 
 check:
-	pre-commit run --all-files
+	pdm run pre-commit run --all-files
 
 version:
-	@poetry version $(v)
-	@git add pyproject.toml
-	@git commit -m "v$$(poetry version -s)"
-	@git tag v$$(poetry version -s)
+	@hatch version $(v)
+	@git add __about__.py
+	@git commit -m "Bumping to v$$(hatch version)"
+	@git tag v$$(hatch version)
 	@git push
 	@git push --tags
-	@poetry version
+	@hatch version
 
 release:
-	@poetry publish --build
+	@hatch publish --build
diff --git a/client/python/.gitignore b/client/python/.gitignore
@@ -52,3 +52,4 @@ MANIFEST
 .venv*/
 .conda*/
 .python-version
+.pdm-python
diff --git a/client/python/Makefile b/client/python/Makefile
@@ -1,8 +1,8 @@
 check:
-	poetry run pre-commit run --all-files
+	pdm run pre-commit run --all-files
 
 test:
-	poetry run pytest tests/ ${PYTEST_ARGS} --cov datajunction --cov-report term-missing --verbose
+	pdm run pytest --cov=datajunction --cov-report=html -vv tests/ --doctest-modules datajunction --without-integration --without-slow-integration ${PYTEST_ARGS}
 
 version:
 	@poetry version $(v)

diff --git a/client/python/__pypackages__/.gitignore b/client/python/__pypackages__/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
Original file line number	Diff line number	Diff line change
Expand Up		@@ -114,3 +114,4 @@ ENV/

		# MacOS
		.DS_Store
		.pdm-python