ci(.github/action): add release-candidate-ready-for-qa GitHub action #144

maksym-shynkarenko · 2024-03-19T11:46:31Z

Add the GitHub Action release-candidate-ready-for-qa

Closes: #426

CLAassistant · 2024-03-19T11:46:38Z

All committers have signed the CLA.

straker · 2024-03-19T15:20:42Z

.github/actions/deploy-release-candidate-v1/README.md

+| Name            | Required | Description                                                | Default |
+| --------------- | -------- | ---------------------------------------------------------- | ------- |
+| `version`       | Yes      | A version of the release candidate                         | NA      |
+| `revision-url`  | Yes      | A commit revision URL                                      | NA      |


This shouldn't be hardcoded into the action but instead derived. It should use the current SHA of the release branch to get the build id as the SHA is used in the build name (for example https://github.com/dequelabs/axe-core-npm/blob/develop/.github/workflows/deploy.yml#L62).

The final build name should be: the package name and version, followed by rc and the SHA.

For example, if @axe-core/puppeteer were to deploy an RC for version 4.9.0 and the current release brach SHA was 726e3c4, the final name of the build QA should use is:

axe-core/puppeteer-4.9.0-rc-726e3c4

straker · 2024-03-19T15:31:39Z

.github/actions/deploy-release-candidate-v1/README.md

+
+| Name            | Required | Description                                                | Default |
+| --------------- | -------- | ---------------------------------------------------------- | ------- |
+| `version`       | Yes      | A version of the release candidate                         | NA      |


This shouldn't be hardcoded as the version changes every deploy. It will need to be taken from the package/lerna.json of the release brach.

It should use #115. Since this is the 3rd time we've needed to use this script we should create that action first, merge it, then bring it into this action to use.

straker · 2024-03-19T15:59:42Z

.github/actions/deploy-release-candidate-v1/README.md

+| --------------- | -------- | ---------------------------------------------------------- | ------- |
+| `version`       | Yes      | A version of the release candidate                         | NA      |
+| `revision-url`  | Yes      | A commit revision URL                                      | NA      |
+| `owner`         | Yes      | An owner of the repository                                 | NA      |


straker · 2024-03-19T16:00:34Z

.github/actions/deploy-release-candidate-v1/README.md

+| `version`       | Yes      | A version of the release candidate                         | NA      |
+| `revision-url`  | Yes      | A commit revision URL                                      | NA      |
+| `owner`         | Yes      | An owner of the repository                                 | NA      |
+| `repo`          | Yes      | A repository name                                          | NA      |


straker · 2024-03-19T16:09:40Z

.github/actions/deploy-release-candidate-v1/README.md

+| `owner`         | Yes      | An owner of the repository                                 | NA      |
+| `repo`          | Yes      | A repository name                                          | NA      |
+| `slack-webhook` | Yes      | A Slack channel webhook URL where the message will be sent | NA      |
+| `slack-channel` | No       | A Slack channel name where the message will be sent        | NA      |


This is probably fine to hardcode into the action. I don't think we should be posting these release candidate build messages to different slack channels so shouldn't give the user an option. We can change that in the future if that ever happens and just have this default to api-team-releases.

straker · 2024-03-19T16:12:35Z

.github/actions/deploy-release-candidate-v1/action.yml

+        if [[ -z "${{ steps.get-release-issue.outputs.issue-url }}" ]]; then
+          echo "::error::No release issue has been found"
+          exit 1
+        fi


I assume you're trying to exit early if no ticket is found? If so you should use the gh run commands to do that

gh run cancel ${{ github.run_id }} gh run watch ${{ github.run_id }}

https://stackoverflow.com/a/75809743/2124254

as discussed with @straker we leave the original code because it shows the correct error message

straker · 2024-03-19T17:04:32Z

Forgot to mention, we should rename this action since it does not deploy anything, just moves tickets around and posts to slack. So maybe post-deploy-release-candidate or announce-deploy-release-candidate? @Zidious @michael-siek any thoughts on the naming?

michael-siek · 2024-03-19T17:07:15Z

I think deploy-release-candidate-notification would be good

Zidious · 2024-03-19T18:37:20Z

Forgot to mention, we should rename this action since it does not deploy anything, just moves tickets around and posts to slack. So maybe post-deploy-release-candidate or announce-deploy-release-candidate? @Zidious @michael-siek any thoughts on the naming?

The ones you and Michael suggested sound more like the name we should move too, I think its better if we remove deploy though, then maybe announce-release-candidate? Other possible names:

move-release-candidate
qa-release-candidate
release-candidate-merged

straker · 2024-03-21T20:28:46Z

release-candidate-ready-for-qa

…ate-ready-for-qa. Change release-candidate-ready-for-qa

everything is done

straker · 2024-03-28T22:14:09Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

+      - uses: actions/checkout@v4
+      - uses: dequelabs/axe-api-team-public/.github/actions/release-candidate-ready-for-qa-v1-v1@main
+        with:
+          sha-rc: 4b632c61


This shouldn't be an input, it should be calculated using the release branch sha.

git checkout release git rev-parse --short HEAD

a branch name should not be hardcoded. A workflow file should take responsibility for the branch name where this action is called

straker · 2024-03-28T22:18:12Z

.github/actions/release-candidate-ready-for-qa-v1/action.yml

+    - name: Get owner and repository name
+      id: get-owner-repo-name
+      shell: bash
+      run: |
+        if [[ -n "${{ inputs.owner }}" ]]; then
+          ORGANIZATION="${{ inputs.owner }}"
+        else
+          IFS='/' read -r ORGANIZATION _ <<< "$GITHUB_REPOSITORY"
+        fi
+
+        if [[ -n "${{ inputs.repo }}" ]]; then
+          REPOSITORY="${{ inputs.repo }}"
+        else
+          IFS='/' read -r _ REPOSITORY <<< "$GITHUB_REPOSITORY"
+        fi
+
+        echo "owner=$ORGANIZATION" >> $GITHUB_OUTPUT
+        echo "repo=$REPOSITORY" >> $GITHUB_OUTPUT


You don't need to do this. repo and owner have default values in https://github.com/dequelabs/axe-api-team-public/blob/main/.github/actions/get-release-issue-v1/src/run.ts#L8-L9 so you can just forward the repo and owner inputs directly and let the release issue action use the defaults if none are provided.

In the get-release-issue-v1 these are optional params so I leave it as in that action. Also, the repo name is used for adding a comment to an issue https://github.com/dequelabs/axe-api-team-public/blob/ci-add-deploy-release-candidate/.github/actions/release-candidate-ready-for-qa-v1/action.yml#L63

Since GH_REPO is not needed to add a comment since we provide the issue url, this step is not needed and can be removed.

also, I will remove inputs.owner, inputs.repo because they are not needed

…ci-add-deploy-release-candidate

…e-candidate-ready-for-qa action

changed according to the review

straker · 2024-04-03T13:57:06Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

@@ -0,0 +1,33 @@
+# release-candidate-ready-for-qa-v1
+
+A GitHub Action to prepare already created a release candidate for QA.


Suggested change

A GitHub Action to prepare already created a release candidate for QA.

A GitHub Action that lets the QA team know a release candidate is ready for QA

straker · 2024-04-03T13:58:25Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

+
+| Name            | Required | Description                                                | Default                      |
+| --------------- | -------- | ---------------------------------------------------------- | ---------------------------- |
+| `sha-rc`        | No       | SHA of the release commit from the release branch          | git rev-parse --short=8 HEAD |


straker · 2024-04-03T13:59:41Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

+| --------------- | -------- | ---------------------------------------------------------- | ---------------------------- |
+| `sha-rc`        | No       | SHA of the release commit from the release branch          | git rev-parse --short=8 HEAD |
+| `slack-webhook` | Yes      | A Slack channel webhook URL where the message will be sent | NA                           |
+| `owner`         | No       | An owner of the repository                                 | $GITHUB_REPOSITORY           |


I will remove this because it's not needed

straker · 2024-04-03T13:59:59Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

+| `sha-rc`        | No       | SHA of the release commit from the release branch          | git rev-parse --short=8 HEAD |
+| `slack-webhook` | Yes      | A Slack channel webhook URL where the message will be sent | NA                           |
+| `owner`         | No       | An owner of the repository                                 | $GITHUB_REPOSITORY           |
+| `repo`          | No       | A repository name                                          | $GITHUB_REPOSITORY           |


I will remove this because it's not needed

straker · 2024-04-03T14:02:56Z

.github/actions/release-candidate-ready-for-qa-v1/README.md

+    permissions:
+      issues: write


Since write permissions are needed (I assume for gh issue comment command to write a comment), we should spell that out similar to how we've listed permissions in other repos

straker · 2024-04-03T14:08:18Z

.github/actions/release-candidate-ready-for-qa-v1/action.yml

@@ -0,0 +1,98 @@
+name: release-candidate-ready-for-qa-v1
+description: Preparing a release candidate issue for QA


Suggested change

description: Preparing a release candidate issue for QA

description: Lets the QA team know a release candidate is ready for QA

straker · 2024-04-03T14:09:13Z

.github/actions/release-candidate-ready-for-qa-v1/action.yml

+
+inputs:
+  sha-rc:
+    description: SHA of the release commit from the release branch


Suggested change

description: SHA of the release commit from the release branch

description: 8 character SHA of the release commit from the release branch

straker · 2024-04-03T14:30:47Z

.github/actions/release-candidate-ready-for-qa-v1/action.yml

+      shell: bash
+      run: gh issue comment ${{ steps.get-release-issue.outputs.issue-url }} --body "$BODY"
+      env:
+        GH_REPO: ${{ steps.get-owner-repo-name.outputs.repo }}


GH_REPO is only needed if you don't supply a url (i.e. use an issue number). Since we provide the url the repo is parsed from that. Testing in my terminal this works

GH_TOKEN=<token> gh issue comment https://github.com/dequelabs/<repo>/issues/<number> -b "hello world"

Suggested change

GH_REPO: ${{ steps.get-owner-repo-name.outputs.repo }}

straker · 2024-04-03T14:37:23Z

.github/actions/release-candidate-ready-for-qa-v1/action.yml

+    - name: Get owner and repository name
+      id: get-owner-repo-name
+      shell: bash
+      run: |
+        if [[ -n "${{ inputs.owner }}" ]]; then
+          ORGANIZATION="${{ inputs.owner }}"
+        else
+          IFS='/' read -r ORGANIZATION _ <<< "$GITHUB_REPOSITORY"
+        fi
+
+        if [[ -n "${{ inputs.repo }}" ]]; then
+          REPOSITORY="${{ inputs.repo }}"
+        else
+          IFS='/' read -r _ REPOSITORY <<< "$GITHUB_REPOSITORY"
+        fi
+
+        echo "owner=$ORGANIZATION" >> $GITHUB_OUTPUT
+        echo "repo=$REPOSITORY" >> $GITHUB_OUTPUT


Since GH_REPO is not needed to add a comment since we provide the issue url, this step is not needed and can be removed.

…candidate-ready-for-qa-v1 action. Change the Readme file of this action

changed according to the review

straker

@maksym-shynkarenko showed me the results of testing it in a test repo with release-like issues so we should be good to merge. We'll do another test once this is merged to verify in actual codebase.

maksym-shynkarenko requested a review from a team as a code owner March 19, 2024 11:46

straker previously requested changes Mar 19, 2024

View reviewed changes

ci(.github/action): add deploy-release-candidate GitHub action

426a6b6

maksym-shynkarenko force-pushed the ci-add-deploy-release-candidate branch from 0c9bedb to 426a6b6 Compare March 19, 2024 17:02

maksym-shynkarenko added 3 commits March 26, 2024 15:46

ci(.github/action): rename deploy-release-candidate to release-candid…

efebdec

…ate-ready-for-qa. Change release-candidate-ready-for-qa

ci(.github/action): create build files for get-release-issue-v1

23784ee

ci(.github/action): change the lint script in the get-release-issue-v1

5eb8b67

maksym-shynkarenko changed the title ~~ci(.github/action): add deploy-release-candidate GitHub action~~ ci(.github/action): add release-candidate-ready-for-qa GitHub action Mar 26, 2024

maksym-shynkarenko requested a review from straker March 28, 2024 13:19

ci(.github/action): change readme file of release-candidate-ready-for-qa

e53e707

straker previously requested changes Mar 28, 2024

View reviewed changes

maksym-shynkarenko added 2 commits April 3, 2024 13:57

Merge branch 'main' of github.com:dequelabs/axe-api-team-public into …

eff5a62

…ci-add-deploy-release-candidate

ci(.github/action): change the sha-rc input as optional in the releas…

c7ae941

…e-candidate-ready-for-qa action

maksym-shynkarenko requested a review from straker April 3, 2024 11:52

straker previously requested changes Apr 3, 2024

View reviewed changes

ci(.github/action): delete repo name and owner inputs in the release-…

479fcb8

…candidate-ready-for-qa-v1 action. Change the Readme file of this action

maksym-shynkarenko requested a review from straker April 4, 2024 12:58

straker approved these changes Apr 4, 2024

View reviewed changes

maksym-shynkarenko merged commit 055c6e4 into main Apr 4, 2024
15 checks passed

maksym-shynkarenko deleted the ci-add-deploy-release-candidate branch April 4, 2024 14:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(.github/action): add release-candidate-ready-for-qa GitHub action #144

ci(.github/action): add release-candidate-ready-for-qa GitHub action #144

maksym-shynkarenko commented Mar 19, 2024 •

edited

Loading

CLAassistant commented Mar 19, 2024 •

edited

Loading

straker Mar 19, 2024

straker Mar 19, 2024

straker Mar 19, 2024

straker Mar 19, 2024

straker Mar 19, 2024

straker Mar 19, 2024

maksym-shynkarenko Mar 22, 2024

straker commented Mar 19, 2024 •

edited

Loading

michael-siek commented Mar 19, 2024

Zidious commented Mar 19, 2024

straker commented Mar 21, 2024

straker Mar 28, 2024

maksym-shynkarenko Apr 3, 2024

straker Mar 28, 2024

maksym-shynkarenko Mar 29, 2024

straker Apr 3, 2024

maksym-shynkarenko Apr 4, 2024

straker Apr 3, 2024

straker Apr 3, 2024

straker Apr 3, 2024 •

edited

Loading

maksym-shynkarenko Apr 4, 2024

straker Apr 3, 2024 •

edited

Loading

maksym-shynkarenko Apr 4, 2024

straker Apr 3, 2024

straker Apr 3, 2024

straker Apr 3, 2024

straker Apr 3, 2024 •

edited

Loading

straker Apr 3, 2024

straker left a comment

	\| `owner` \| Yes \| An owner of the repository \| NA \|
	\| `owner` \| No \| The owner of the repository e.g. dequelabs/axe-core-npm, then supply "dequelabs" \| `github.context.repo.owner` \|

	\| `repo` \| Yes \| A repository name \| NA \|
	\| `repo` \| No \| The repository e.g. dequelabs/axe-core-npm, then supply "axe-core-npm" \| `github.context.repo.repo` \|

		@@ -0,0 +1,33 @@
		# release-candidate-ready-for-qa-v1

		A GitHub Action to prepare already created a release candidate for QA.

	A GitHub Action to prepare already created a release candidate for QA.
	A GitHub Action that lets the QA team know a release candidate is ready for QA

	\| `sha-rc` \| No \| SHA of the release commit from the release branch \| git rev-parse --short=8 HEAD \|
	\| `sha-rc` \| No \| 8 character SHA of the release commit from the release branch \| git rev-parse --short=8 HEAD \|

	\| `owner` \| No \| An owner of the repository \| $GITHUB_REPOSITORY \|
	\| `owner` \| No \| The owner of the repository e.g. dequelabs/axe-core-npm, then supply "dequelabs" \| $GITHUB_REPOSITORY \|

	\| `repo` \| No \| A repository name \| $GITHUB_REPOSITORY \|
	\| `repo` \| No \| The repository e.g. dequelabs/axe-core-npm, then supply "axe-core-npm" \| $GITHUB_REPOSITORY \|

		@@ -0,0 +1,98 @@
		name: release-candidate-ready-for-qa-v1
		description: Preparing a release candidate issue for QA

	description: Preparing a release candidate issue for QA
	description: Lets the QA team know a release candidate is ready for QA

	description: SHA of the release commit from the release branch
	description: 8 character SHA of the release commit from the release branch

ci(.github/action): add release-candidate-ready-for-qa GitHub action #144

ci(.github/action): add release-candidate-ready-for-qa GitHub action #144

Conversation

maksym-shynkarenko commented Mar 19, 2024 • edited Loading

CLAassistant commented Mar 19, 2024 • edited Loading

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

straker commented Mar 19, 2024 • edited Loading

michael-siek commented Mar 19, 2024

Zidious commented Mar 19, 2024

straker commented Mar 21, 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

Choose a reason for hiding this comment

straker Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

straker Apr 3, 2024 • edited Loading

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

straker Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

straker left a comment

Choose a reason for hiding this comment

maksym-shynkarenko commented Mar 19, 2024 •

edited

Loading

CLAassistant commented Mar 19, 2024 •

edited

Loading

straker commented Mar 19, 2024 •

edited

Loading

straker Apr 3, 2024 •

edited

Loading

straker Apr 3, 2024 •

edited

Loading

straker Apr 3, 2024 •

edited

Loading