From 19b14018ce61628ba9be8fb92541dbfe11ecfdaa Mon Sep 17 00:00:00 2001 From: Azeem Shaikh Date: Fri, 15 Jul 2022 15:12:55 +0000 Subject: [PATCH 1/3] Prepare for v2 beta1 release --- RELEASE.md | 42 ++++++++++++++++++++++++++---------------- action.yaml | 2 +- 2 files changed, 27 insertions(+), 17 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 0793240f..b0f6e45e 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -30,6 +30,32 @@ We're not striving for perfection with the template, but the tracking issue will serve as a reference point to aggregate feedback, so try your best to be as descriptive as possible. +## Preparing the release + +This section covers changes that need to be issued as a pull request and should +be merged before releasing the scorecard GitHub Action. + +### Update the scorecard-action version + +NOTE: we have a chicken-and-egg problem where the commit to be used for the release +needs to have the image tag that only gets created *after* the commit is pushed. We +workaround that by pre-selecting and referencing the image tag instead of the SHA which isn't ideal +but workable. + +Pre-select the tag which will be used for the release. For this document, we'll use: `Tag`. + +Update the image tage in [action.yaml](action.yaml) to use `Tag`. + +Example: + +``` +runs: + using: "docker" + image: "docker://gcr.io/openssf/scorecard-action:Tag" +``` + +Create a pull request with this change and merge into `main`. + ## Drafting release notes @@ -47,22 +73,6 @@ git tag -s -m "v100.0.0" v100.0.0 git push --tags ``` -### Update the scorecard-action version - -Note be the hash of the scorecard-action image (say, `CH1`) that was tagged with `Tag`. We will use this for the release. - -Update the digest in [action.yaml](action.yaml) to use `CH1`. - -Example: - -``` -runs: - using: "docker" - image: "docker://gcr.io/openssf/scorecard-action:CH1" -``` - -Create a pull request with this change and merge into `main`. - ### Create a GitHub release Create a diff --git a/action.yaml b/action.yaml index 007b365e..9f093fd3 100644 --- a/action.yaml +++ b/action.yaml @@ -48,6 +48,6 @@ branding: runs: using: "docker" - image: "docker://gcr.io/openssf/scorecard-action:latest" + image: "docker://gcr.io/openssf/scorecard-action:v2.0.0-beta1" From 42538878cfc62f949ddc523d079d61f634dd57e0 Mon Sep 17 00:00:00 2001 From: Azeem Shaikh Date: Fri, 15 Jul 2022 08:30:27 -0700 Subject: [PATCH 2/3] Address PR comment - semver compliant tag Co-authored-by: Stephen Augustus (he/him) --- action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yaml b/action.yaml index 9f093fd3..fca85f3f 100644 --- a/action.yaml +++ b/action.yaml @@ -48,6 +48,6 @@ branding: runs: using: "docker" - image: "docker://gcr.io/openssf/scorecard-action:v2.0.0-beta1" + image: "docker://gcr.io/openssf/scorecard-action:v2.0.0-beta.1" From aa97af5e10fa91cc57387ab519a52e99f85622ba Mon Sep 17 00:00:00 2001 From: Azeem Shaikh Date: Fri, 15 Jul 2022 18:56:16 +0000 Subject: [PATCH 3/3] Fix typo: tage -> tag --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index b0f6e45e..c9e95e85 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -44,7 +44,7 @@ but workable. Pre-select the tag which will be used for the release. For this document, we'll use: `Tag`. -Update the image tage in [action.yaml](action.yaml) to use `Tag`. +Update the image tag in [action.yaml](action.yaml) to use `Tag`. Example: