Release v0.2.0 (#31)

* Release v0.2.0

* Add JetStream MaxText TPU inference user guide

* update links in README

* fix variable in README

* Add MANIFEST.in for python pkg build

* Update README - Apply suggestions from code review

.github/workflows/release.yaml

@@ -0,0 +1,81 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# This workflow will create a release with git tag and publish a Python Package in PyPI.
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions; https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+
+name: Create Release
+
+on:
+  push:
+    tags:
+      - v*
+
+# Needed to create release and upload assets
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Create Release with tag
+    runs-on: ${{ matrix.os }}
+    needs: release
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: ['3.10']
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Extract release tag from branch
+      shell: bash
+      run: |
+        echo "release_tag=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+    - name: Create Github Release
+      id: create_release
+      uses: "actions/github-script@v6"
+      env:
+        RELEASE_TAG: ${{ env.release_tag }}
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"
+        script: |
+          const script = require('.github/workflows/scripts/create_release.js')
+          await script(github, context, core)
+
+  pypi:
+    name: Build and Publish JetStream Python Package
+    runs-on: ${{ matrix.os }}
+    needs: release
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: ['3.10']
+    environment:
+      name: pypi
+      url: https://pypi.org/project/google-jetstream
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Build Python distribution package
+      run: |
+        python -m pip install --upgrade build && python -m build
+    - name: Publish Python package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/scripts/create_release.js

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Uses Github's API to create the release and wait for result.
+// We use a JS script since github CLI doesn't provide a way to wait for the release's creation and returns immediately.
+
+module.exports = async (github, context, core) => {
+	try {
+		const response = await github.rest.repos.createRelease({
+			draft: false,
+			generate_release_notes: true,
+			name: process.env.RELEASE_TAG,
+			owner: context.repo.owner,
+			prerelease: false,
+			repo: context.repo.repo,
+			tag_name: process.env.RELEASE_TAG,
+		});
+
+		core.setOutput('upload_url', response.data.upload_url);
+	} catch (error) {
+		core.setFailed(error.message);
+	}
+}

.github/workflows/UnitTests.yaml → .github/workflows/unit_tests.yaml

@@ -35,7 +35,8 @@ jobs:
         python-version: ['3.10']
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - name: Checkout
+      uses: actions/checkout@v4
     - name: Setup Python
       uses: actions/setup-python@v4
       with:
@@ -64,7 +65,8 @@ jobs:
         python-version: ['3.10']
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - name: Checkout
+      uses: actions/checkout@v4
     - name: Setup Python
       uses: actions/setup-python@v4
       with:

MANIFEST.in

@@ -0,0 +1 @@
+include requirements.in