Automate supported releases bookkeeping (#4158)

Author: schmittjoseph

.github/actions/action-utils.js

@@ -18,5 +18,37 @@ module.exports.installAndRequirePackages = async function(...newPackages)
     return requiredPackages;
 }
 
+function splitVersionTag(tag) {
+    const regex = /v(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(-(?<versionLabel>[a-zA-Z]+)\.(?<iteration>\d+))?/;
+    const releaseVersion = regex.exec(tag);
+    if (releaseVersion == null) throw "Error: Unexpected tag format";
+
+    return [
+        Number(releaseVersion.groups.major),
+        Number(releaseVersion.groups.minor),
+        Number(releaseVersion.groups.patch),
+        (releaseVersion.groups.iteration === undefined) ? undefined : Number(releaseVersion.groups.iteration),
+        releaseVersion.groups.versionLabel
+    ];
+}
+
+module.exports.isVersionTagRTM = function(tag) {
+    const [_, __, ___, iteration] = splitVersionTag(tag);
+
+    return iteration === undefined;
+}
+
+module.exports.friendlyDateFromISODate = function(isoDate) {
+    if (isoDate === undefined) {
+        return undefined;
+    }
+
+    return new Date(isoDate).toLocaleString(
+        "en-us", {
+            dateStyle: "long"
+        });
+}
+
+module.exports.splitVersionTag = splitVersionTag;
 module.exports.readFile = (fileName) => util.promisify(fs.readFile)(fileName, 'utf8');
 module.exports.writeFile = (fileName, contents) => util.promisify(fs.writeFile)(fileName, contents);

.github/actions/gh-script-utils/create-or-update-ref.js

@@ -0,0 +1,32 @@
+module.exports = async (github, context, baseSha, branchName) => {
+    const refName = `heads/${branchName}`;
+
+    // Check if the ref already exists, if so we will need to fast forward it.
+    let needToCreateRef = true;
+    try {
+        await github.rest.git.getRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: refName
+        });
+        needToCreateRef = false;
+    } catch {
+    }
+
+    if (needToCreateRef) {
+        await github.rest.git.createRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            sha: baseSha,
+            ref: `refs/${refName}`
+        });
+    } else {
+        await github.rest.git.updateRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            sha: baseSha,
+            ref: refName,
+            force: true
+        });
+    }
+}

.github/actions/open-pr/action.yml

@@ -4,6 +4,9 @@ inputs:
   branch_name:
     description: 'The branch name to create. Will be prefixed with "bot/".'
     required: true
+  base_branch:
+    description: 'The base branch name to open a PR against. Will default to the current branch if not specified.'
+    required: false
   title:
     description: 'The PR title.'
     required: true
@@ -22,6 +25,9 @@ inputs:
   fail_if_files_unchanged:
     description: 'Fails the action if all of the specified files_to_commit are unchanged.'
     required: false
+  update_if_already_exists:
+    description: 'Allows updating an existing PR, or re-opening it if closed.'
+    required: false
   auth_token:
     description: 'The token used to authenticate to GitHub.'
     required: true
@@ -37,16 +43,21 @@ runs:
         current_branch_name=$(git symbolic-ref --short HEAD)
         pr_branch_name="bot/$BRANCH_NAME"
 
+        if [[ "$UPDATE_IF_ALREADY_EXISTS" != "true" ]] || [[ "$current_branch_name" != "$pr_branch_name" ]]; then
+          git checkout -b "$pr_branch_name"
+        fi
+
+        base_branch_name=${BASE_BRANCH_NAME:-${current_branch_name}}
+
         git config user.name "github-actions"
         git config user.email "[email protected]"
-        git checkout -b "$pr_branch_name"
         git add ${{ inputs.files_to_commit }}
 
         are_files_changed=""
         git diff --name-only --cached --exit-code || are_files_changed="1"
         if [ "$are_files_changed" != "1" ]; then
           echo "No files changed, nothing to do."
-          if [ "${{ inputs.fail_if_files_unchanged }}" == "true" ]; then
+          if [ "$FAIL_IF_FILES_UNCHANGED" == "true" ]; then
             exit 1
           fi
 
@@ -61,13 +72,16 @@ runs:
           extraArgs="${extraArgs} --draft"
         fi
 
-        gh pr create --repo "${{ github.repository }}" --base "$current_branch_name" -t "$TITLE" -b "$BODY_MESSAGE" $extraArgs --label "$LABELS"
+        gh pr create --repo "${{ github.repository }}" --base "$base_branch_name" -t "$TITLE" -b "$BODY_MESSAGE" $extraArgs --label "$LABELS" || [[ "$UPDATE_IF_ALREADY_EXISTS" == "true" ]]
       shell: bash
       env:
         BODY_MESSAGE: ${{ inputs.body }}
         BRANCH_NAME: ${{ inputs.branch_name }}
+        BASE_BRANCH_NAME: ${{ inputs.base_branch }}
         COMMIT_MESSAGE: ${{ inputs.commit_message }}
         DRAFT: ${{ inputs.draft }}
         LABELS: ${{ inputs.labels }}
+        FAIL_IF_FILES_UNCHANGED: ${{ inputs.fail_if_files_unchanged }}
+        UPDATE_IF_ALREADY_EXISTS: ${{ inputs.update_if_already_exists }}
         TITLE: ${{ inputs.title }}
         GITHUB_TOKEN: ${{ inputs.auth_token }}

.github/actions/update-releases-json/action.yml

@@ -0,0 +1,19 @@
+name: 'Update releases json file'
+description: 'Update releases json file'
+inputs:
+  auth_token:
+    description: 'The token used to authenticate to GitHub.'
+    required: false
+  releases_json_file:
+    description: 'The input releases json file path.'
+    required: true
+  supported_frameworks:
+    description: 'The frameworks supported by the new release.'
+    required: false
+  end_of_support_discussion_category:
+    description: 'The discussion category to post about a version going out of support soon.'
+    required: false
+
+runs:
+  using: 'node16'
+  main: 'index.js'

.github/actions/update-releases-json/end_of_support_discussion.template.md

@@ -0,0 +1,21 @@
+On ${endOfSupportDate}, the ${majorMinorVersion}.X versions of `dotnet monitor` will be out of support. After this date, we will no longer provide any bug or security fixes for these versions.
+
+Please refer to [Releases](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/releases.md) to see the currently supported versions.
+
+Please update to a newer version in order to remain in support using one of the following:
+
+## .NET Tool
+
+This will update the installation to the most recent release of `dotnet monitor`:
+
+```
+dotnet tool update -g dotnet-monitor
+```
+
+## Docker Image
+
+Use the Docker image name without specifying a tag to get the most recent release of `dotnet monitor`:
+
+```
+docker pull mcr.microsoft.com/dotnet/monitor
+```