GitHub Actions: Add Release workflow #691

ArangoGutierrez · 2024-05-03T08:12:04Z

No description provided.

ArangoGutierrez · 2024-05-03T08:12:13Z

Depends on #687

elezar

We also spoke about uploading the helm packages and then publishing those to gh-pages. Is that still a goal for this PR?

.github/workflows/release.yaml

hack/update-helm-index.sh

.github/workflows/helm.yaml

hack/update-helm-index.sh

ArangoGutierrez · 2024-05-06T15:40:27Z

@elezar PTAL

hack/update-helm-index.sh

elezar

Thanks for iterating on this.

Please also update RELEASE.md to reflect the changes here.

hack/update-helm-index.sh

.github/workflows/helm.yaml

hack/update-helm-index.sh

RELEASE.md

hack/update-helm-index.sh

ArangoGutierrez · 2024-05-21T14:09:12Z

@elezar / @tariq1890 PTAL

elezar

I think there are some finer points in the implementation that still need to be looked at.

.github/workflows/helm.yaml

elezar · 2024-05-28T09:16:31Z

.github/workflows/helm.yaml

+        git config user.name "Github Actions"
+        git config user.email "no-reply@github.com"


Question (not a blocker): can this be set in the action somehow?

you mean like as an argument to the action?
The documentation and examples I have found all play it like this.

elezar · 2024-05-28T09:18:12Z

.github/workflows/release.yaml

+          GH_EXTRA_ARGS=""
+          if [[ ${{ github.ref }} == *rc* ]]; then
+            GH_EXTRA_ARGS="--prerelease"
+          fi
+          gh release create ${{ github.ref }} \
+            --draft \
+            -t "${{ github.ref }}" \
+            -n $(./hack/generate-changelog.sh --version ${{ github.ref }}) \
+            -R $OWNER/$REPO \
+            --verify-tag \
+            $GH_EXTRA_ARGS


Is this something that we want to have in a script instead?

ummm I think this one and the next one(same comment) are good to have here since they are not functionality we would do manually. and is good to have GitHub actions that are readable.
So I would say no, I prefer to keep this as is

elezar · 2024-05-28T09:19:26Z

.github/workflows/release.yaml

+          gh release upload ${{ github.ref }} ./nvidia-device-plugin-${{ github.event.release.tag_name }}.tgz -R $OWNER/$REPO
+          gh release upload ${{ github.ref }} ./gpu-feature-discovery-${{ github.event.release.tag_name }}.tgz -R $OWNER/$REPO


also a script?

answer on the comment above

elezar · 2024-05-28T09:21:45Z

RELEASE.md

- [ ] Wait for the [CI job associated with your tag] (https://gitlab.com/nvidia/kubernetes/device-plugin/-/pipelines) to complete
- [ ] Create a [new release](https://github.com/NVIDIA/k8s-device-plugin/releases) on Github with the changelog
+- [ ] Wait for the `Release` GitHub Action to complete
+- [ ] Create a [new release](https://github.com/NVIDIA/k8s-device-plugin/releases) from the draft release created by the GitHub Action


Nit:

Suggested change

- [ ] Create a [new release](https://github.com/NVIDIA/k8s-device-plugin/releases) from the draft release created by the GitHub Action

- [ ] Publish the [draft release](https://github.com/NVIDIA/k8s-device-plugin/releases) created by the GitHub Action

elezar · 2024-05-28T09:33:49Z

hack/update-helm-index.sh

+if [ -n "$asset_local" ]; then
+	echo "Copying $asset_local..."
+	cp -f $asset_local $HELM_REPO_PATH/stable
+fi


I don't think this works the way we want. We are in $HELM_REPO_PATH/stable meaning that $asset_local would be interpreted relative to that path.

HELM_REPO_PATH is the absolute path, so it doesn't matter where we are, the cp will perform the copy to the given path.

What if we have to run these locally as in the "troubleshooting" case?

elezar · 2024-05-28T09:35:03Z

hack/update-helm-index.sh

+fi
+
+echo "Updating helm index"
+helm repo index stable --merge index.yaml --url https://nvidia.github.io/k8s-device-plugin/stable


We're in $HELM_REPO_PATH/stable. Does that mean that this should be:

```suggestion helm repo index . --merge index.yaml --url https://nvidia.github.io/k8s-device-plugin/stable

elezar · 2024-05-28T09:35:42Z

hack/update-helm-index.sh

+
+echo "Updating helm index"
+helm repo index stable --merge index.yaml --url https://nvidia.github.io/k8s-device-plugin/stable
+cp -f stable/index.yaml index.yaml


Since we're in $HELM_REPO_PATH/stable this command is invalid. Should it be:

Suggested change

cp -f stable/index.yaml index.yaml

cp -f index.yaml ../index.yaml

elezar · 2024-05-28T09:36:47Z

hack/update-helm-index.sh

+cp -f stable/index.yaml index.yaml
+popd > /dev/null
+
+pushd $HELM_REPO_PATH > /dev/null


Should we use git -C for the git commands instead of pushd/popd?

elezar · 2024-05-28T09:38:21Z

.github/workflows/helm.yaml

+
+    - name: Push updated Helm charts and index to gh-pages branch
+      env:
+        HELM_REPO_PATH: releases/helm-${{ github.event.release.tag_name }}/


Question: Could we set HELM_REPO_PATH as a job-level envvar?

ArangoGutierrez · 2024-05-28T15:43:36Z

Updated as discussed @elezar

.github/workflows/helm.yaml

hack/update-helm-index.sh

RELEASE.md

.github/workflows/release.yaml

elezar · 2024-06-17T14:29:17Z

.github/workflows/release.yaml

+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}
+        run: |
+          GH_EXTRA_ARGS=""


This does not work as expected. See https://github.com/NVIDIA/nvidia-container-toolkit/actions/runs/9549456867/job/26319106625

Also when running the gh command line as given, it asks a number of questions. Not sure whether that would be skipped in the action.

Fixed with github.ref_name

It should not ask questions, as it should know is running on GItHub Actions mode https://docs.github.com/en/actions/using-workflows/using-github-cli-in-workflows

elezar · 2024-06-17T14:55:00Z

.github/workflows/release.yaml

+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}
+        run: |
+          gh release upload ${{ github.ref_name	}} ./nvidia-device-plugin-${{ github.event.release.tag_name }}.tgz -R $OWNER/$REPO


What value does tag_name have? Do we strip the leading v?

responds to refs/tags/<tag_name> so it will include the v

Ok. Our packages don't include the v though. Can we update this?

Also, as a matter of interest, why do we use tag_name instead of just using ref_name consistently?

how about now?

This change updates the release scripting to create helm packages and update the helm index in the gh-pages branch. Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com> Signed-off-by: Evan Lezar <elezar@nvidia.com>

This change adds GitHub actions that create a draft release when a tag is pushed. This draft release incldes Helm packages for the device plugin. Once this release is published, these helm packages are published to the gh-pages branch. Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com> Signed-off-by: Evan Lezar <elezar@nvidia.com>

Signed-off-by: Evan Lezar <elezar@nvidia.com>

elezar

I have made the required changes to the branch.

elezar · 2024-06-18T11:11:44Z

.github/workflows/release.yaml

+            $GH_EXTRA_ARGS
+
+      - name: Install Helm
+        uses: azure/setup-helm@v4.2.0


Question: Is this one of the allowed actions?

elezar · 2024-06-18T11:12:04Z

.github/workflows/release.yaml

+      - name: Install Helm
+        uses: azure/setup-helm@v4.2.0
+        with:
+          version: 3.14.4


Does it make sense to just use the latest stable version here? Not a blocker for this PR though.

I am never against latest during testing, so I agree we should go latest

elezar · 2024-06-18T11:13:21Z

hack/generate-changelog.sh

@@ -50,7 +50,7 @@ while [[ $# -gt 0 ]]; do
        shift # past value
        ;;
        --version)
-        VERSION="$2"
+        VERSION="$2#v"


This wasn't required in this script.

ArangoGutierrez added the testing issue/PR to fix/edit/create/enhance a project unit/e2e test label May 3, 2024

ArangoGutierrez self-assigned this May 3, 2024

elezar reviewed May 3, 2024

View reviewed changes

.github/workflows/release.yaml Outdated Show resolved Hide resolved

ArangoGutierrez force-pushed the releaseAction branch from 10f0900 to ceedf8f Compare May 3, 2024 10:06

ArangoGutierrez requested review from tariq1890 and elezar May 3, 2024 10:57

elezar reviewed May 3, 2024

View reviewed changes

tariq1890 reviewed May 3, 2024

View reviewed changes

.github/workflows/helm.yaml Outdated Show resolved Hide resolved

.github/workflows/helm.yaml Outdated Show resolved Hide resolved

ArangoGutierrez force-pushed the releaseAction branch from 00b282a to 8995542 Compare May 4, 2024 06:57

ArangoGutierrez requested review from elezar and tariq1890 May 4, 2024 06:57

elezar reviewed May 6, 2024

View reviewed changes

ArangoGutierrez requested a review from elezar May 6, 2024 15:40

ArangoGutierrez mentioned this pull request May 7, 2024

[gh-pages] remove build-index.sh #698

Open

elezar reviewed May 7, 2024

View reviewed changes

hack/update-helm-index.sh Outdated Show resolved Hide resolved

ArangoGutierrez force-pushed the releaseAction branch 2 times, most recently from 1f1ce54 to 323a006 Compare May 8, 2024 07:43

ArangoGutierrez requested a review from elezar May 8, 2024 07:43

elezar requested changes May 8, 2024

View reviewed changes

ArangoGutierrez force-pushed the releaseAction branch 2 times, most recently from 4d6b6e5 to 4e311fa Compare May 8, 2024 09:08

ArangoGutierrez requested a review from elezar May 8, 2024 09:09

elezar reviewed May 8, 2024

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

hack/update-helm-index.sh Outdated Show resolved Hide resolved

ArangoGutierrez force-pushed the releaseAction branch from 4e311fa to 6d8c42b Compare May 8, 2024 09:49

ArangoGutierrez requested a review from elezar May 8, 2024 09:49

elezar requested changes May 28, 2024

View reviewed changes

ArangoGutierrez force-pushed the releaseAction branch from 6d8c42b to 8a8bd30 Compare May 28, 2024 12:17

ArangoGutierrez requested a review from elezar May 28, 2024 12:17

ArangoGutierrez force-pushed the releaseAction branch from 8a8bd30 to b20fbec Compare May 28, 2024 15:43

tariq1890 reviewed May 29, 2024

View reviewed changes

.github/workflows/helm.yaml Outdated Show resolved Hide resolved

tariq1890 reviewed May 29, 2024

View reviewed changes

hack/update-helm-index.sh Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

elezar reviewed Jun 17, 2024

View reviewed changes

.github/workflows/release.yaml Outdated Show resolved Hide resolved

ArangoGutierrez force-pushed the releaseAction branch from b20fbec to ef3e7e2 Compare June 17, 2024 13:44

ArangoGutierrez requested review from tariq1890 and elezar June 17, 2024 13:44

elezar reviewed Jun 17, 2024

View reviewed changes

ArangoGutierrez force-pushed the releaseAction branch from ef3e7e2 to 29eb986 Compare June 17, 2024 14:42

elezar reviewed Jun 17, 2024

View reviewed changes

ArangoGutierrez requested a review from elezar June 17, 2024 15:09

ArangoGutierrez force-pushed the releaseAction branch from 29eb986 to 97829bc Compare June 18, 2024 10:24

elezar force-pushed the releaseAction branch 4 times, most recently from d3090cf to 5b48edf Compare June 18, 2024 12:23

ArangoGutierrez and others added 3 commits June 18, 2024 14:37

[no-relnote] Skip no-relnote messages for changelog

61ac478

Signed-off-by: Evan Lezar <elezar@nvidia.com>

elezar force-pushed the releaseAction branch from 5b48edf to 61ac478 Compare June 18, 2024 12:38

elezar approved these changes Jun 18, 2024

View reviewed changes

elezar enabled auto-merge June 18, 2024 12:39

elezar merged commit ad4aae5 into NVIDIA:main Jun 18, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Actions: Add Release workflow #691

GitHub Actions: Add Release workflow #691

ArangoGutierrez commented May 3, 2024

ArangoGutierrez commented May 3, 2024

elezar left a comment

ArangoGutierrez commented May 6, 2024

elezar left a comment

ArangoGutierrez commented May 21, 2024

elezar left a comment

elezar May 28, 2024

ArangoGutierrez May 28, 2024

elezar May 28, 2024

ArangoGutierrez May 28, 2024

elezar May 28, 2024

ArangoGutierrez May 28, 2024

elezar May 28, 2024

elezar May 28, 2024

ArangoGutierrez May 28, 2024

elezar May 28, 2024

elezar May 28, 2024

elezar May 28, 2024

elezar May 28, 2024

elezar May 28, 2024

ArangoGutierrez commented May 28, 2024

elezar Jun 17, 2024

ArangoGutierrez Jun 17, 2024

ArangoGutierrez Jun 17, 2024

elezar Jun 17, 2024

ArangoGutierrez Jun 17, 2024

elezar Jun 18, 2024

ArangoGutierrez Jun 18, 2024

elezar left a comment

elezar Jun 18, 2024

elezar Jun 18, 2024

ArangoGutierrez Jun 18, 2024

elezar Jun 18, 2024

		git config user.name "Github Actions"
		git config user.email "no-reply@github.com"

		gh release upload ${{ github.ref }} ./nvidia-device-plugin-${{ github.event.release.tag_name }}.tgz -R $OWNER/$REPO
		gh release upload ${{ github.ref }} ./gpu-feature-discovery-${{ github.event.release.tag_name }}.tgz -R $OWNER/$REPO

	- [ ] Create a [new release](https://github.com/NVIDIA/k8s-device-plugin/releases) from the draft release created by the GitHub Action
	- [ ] Publish the [draft release](https://github.com/NVIDIA/k8s-device-plugin/releases) created by the GitHub Action

	cp -f stable/index.yaml index.yaml
	cp -f index.yaml ../index.yaml

GitHub Actions: Add Release workflow #691

GitHub Actions: Add Release workflow #691

Conversation

ArangoGutierrez commented May 3, 2024

ArangoGutierrez commented May 3, 2024

elezar left a comment

Choose a reason for hiding this comment

ArangoGutierrez commented May 6, 2024

elezar left a comment

Choose a reason for hiding this comment

ArangoGutierrez commented May 21, 2024

elezar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArangoGutierrez commented May 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elezar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment