Release process for Vizro AI

.github/workflows/check-release.yml

@@ -69,8 +69,10 @@ jobs:
           hatch build
       - name: Set PyPI token
         run: |
-          if [ "${{ needs.check-version.outputs.PACKAGE_NAME }}" == "vizro-core" ]; then
-              echo 'PYPI_TOKEN=${{ secrets.VIZRO_PYPI_TOKEN }}' >> $GITHUB_ENV
+          if [ "${{ needs.check-version.outputs.package_name }}" == "vizro-core" ]; then
+            echo 'PYPI_TOKEN=${{ secrets.VIZRO_PYPI_TOKEN }}' >> $GITHUB_ENV
+          elif [ "${{ needs.check-version.outputs.package_name }}" == "vizro-ai" ]; then
+            echo 'PYPI_TOKEN=${{ secrets.VIZRO_AI_PYPI_TOKEN }}' >> $GITHUB_ENV
           fi
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
@@ -80,10 +82,10 @@ jobs:
       - name: Check correct package uploaded to PyPI
         run: |
           cd "${{ needs.check-version.outputs.package_name }}/dist"
-          local=$(md5sum vizro-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
+          local=$(md5sum ${{ needs.check-version.outputs.package_name }}-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
           cd ..
-          pip download vizro==${{needs.check-version.outputs.package_version}} -d . --no-deps --timeout 300
-          pypi=$(md5sum vizro-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
+          pip download ${{ needs.check-version.outputs.package_name }}==${{needs.check-version.outputs.package_version}} -d . --no-deps --timeout 300
+          pypi=$(md5sum ${{ needs.check-version.outputs.package_name }}-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
           if [[ $local = $pypi ]]; then echo "md5 hash is the same"; else echo "md5 hash is not the same"; exit 1; fi
 
   version-bump:

tools/check_package_release.py

@@ -5,7 +5,7 @@
 
 import requests
 
-AVAILABLE_PACKAGES = ["vizro-core"]
+AVAILABLE_PACKAGES = ["vizro-core", "vizro-ai"]
 VERSION_MATCHSTR = r'\s*__version__\s*=\s*"(\d+\.\d+\.\d+)"'
 RESPONSE_ERROR = 404
 

tools/release.sh

@@ -13,14 +13,23 @@ GITHUB_ENDPOINT="https://api.github.com/repos/${GITHUB_USER}/${GITHUB_REPO}/rele
 
 BODY=$(jq -Rs . < "$BODY_PATH")
 
+if [ "$PACKAGE" = "vizro-core" ]; then
+  TAG_NAME="${VERSION}"
+  MAKE_LATEST=true
+else
+  TAG_NAME="${PACKAGE}-${VERSION}"
+  MAKE_LATEST=false
+fi
+
 PAYLOAD=$(cat <<-END
 {
-    "tag_name": "${VERSION}",
+    "tag_name": "${TAG_NAME}",
     "target_commitish": "main",
     "name": "${PACKAGE}-${VERSION}",
     "body": ${BODY},
     "draft": false,
-    "prerelease": false
+    "prerelease": false,
+    "make_latest": "${MAKE_LATEST}"
 }
 END
 )
@@ -32,3 +41,5 @@ STATUS=$(curl -L \
   -H "X-GitHub-Api-Version: 2022-11-28" \
   ${GITHUB_ENDPOINT} \
   -d "${PAYLOAD}")
+
+echo "${STATUS}"

vizro-ai/changelog.d/20231031_102652_anna_xiong_vizro_ai_open_source_initial_commits.md

@@ -6,7 +6,7 @@ Uncomment the section that is right (remove the HTML comment wrapper).
 
 ### Highlights ✨
 
-- Initial release of vizro-ai package. Vizro-AI is a tool for generating data visualizations. ([#138](https://github.com/mckinsey/vizro/pull/138))
+- Initial release of `vizro-ai` package. Vizro-AI is a tool for generating data visualizations. ([#138](https://github.com/mckinsey/vizro/pull/138))
 
 <!--
 ### Removed

vizro-ai/changelog.d/20231110_194832_maximilian_schulz_adjust_release_process.md

@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->

vizro-ai/hatch.toml

@@ -6,7 +6,7 @@ python = ["3.9", "3.10", "3.11"]
 [envs.changelog]
 dependencies = ["scriv"]
 detached = true
-scripts = {add = "scriv create --add"}
+scripts = {add = "scriv create --add", collect = ["scriv collect --add", "- hatch run lint:lint --files=CHANGELOG.md > /dev/null"]}
 
 [envs.default]
 dependencies = [
@@ -33,7 +33,7 @@ cov-report = [
 lint = "hatch run lint:lint {args:--all-files}"
 prep-release = [
   "hatch version release",
-  "hatch run changelog:scriv collect --add",
+  "hatch run changelog:collect",
   "hatch run changelog:add",
   'echo "Now raise a PR to merge into main with title: Release of vizro-ai $(hatch version)"'
 ]

vizro-ai/src/vizro_ai/__init__.py

@@ -5,6 +5,6 @@
 
 __all__ = ["VizroAI"]
 
-__version__ = "0.1.0.dev2"
+__version__ = "0.1.0.dev3"
 
 logging.basicConfig(level=os.getenv("VIZRO_AI_LOG_LEVEL", "INFO"))