Release 29

.github/PULL_REQUEST_TEMPLATE.md

@@ -45,7 +45,7 @@ sudo pro new-sub-command --new-flag
 that apply. -->
  - [ ] I have updated or added any unit tests accordingly
  - [ ] I have updated or added any integration tests accordingly
- - [ ] I have updated or added any documentation accordingly
+ - [ ] Changes here need to be documented, and this was done in: <!-- Insert PR number here if the box is checked (ex. #1234) -->
 
 ## Does this PR require extra reviews?
 <!-- Should people outside of the team see and approve these changes before the

.github/actions/bug-refs/index.js

@@ -3,7 +3,7 @@ const github = require('@actions/github');
 
 const commentHeader = "<!-- ubuntu-pro-client-bug-refs -->";
 
-function createCommentBody(commits, title) {
+function createCommentBody(commits, title, body) {
     let newComment = "";
     newComment += commentHeader;
     newComment += "\n";
@@ -49,6 +49,19 @@ function createCommentBody(commits, title) {
     }
     newComment += "\n";
 
+    newComment += "Documentation:";
+    if (!body.includes('[x] Changes here need to be documented')){
+        newComment += " The changes in this PR do not require documentation changes.";
+    } else {
+        docsPullMatch = body.match(/and this was done in: (#\d+)/)
+        if (docsPullMatch){
+            newComment += ` Documentation changes addressed in ${docsPullMatch[1]}`;
+        } else {
+            newComment += " The changes in this PR do require documentation changes, but those were not addressed yet.";
+        }
+    }
+    newComment += "\n\n";
+
     newComment += "👍 this comment to confirm that this is correct.";
 
     return newComment;
@@ -80,7 +93,11 @@ async function run() {
     if (theComment) {
         // comment already exists, update it appropriately
         const existingBody = theComment.body;
-        const newBody = createCommentBody(commits.data, context.payload.pull_request.title);
+        const newBody = createCommentBody(
+            commits.data,
+            context.payload.pull_request.title,
+            context.payload.pull_request.body
+        );
         if (existingBody !== newBody) {
             client.rest.issues.updateComment({
                 owner: context.issue.owner,
@@ -91,13 +108,23 @@ async function run() {
         }
     } else {
         // first run, comment doesn't exist yet
-        const newBody = createCommentBody(commits.data, context.payload.pull_request.title);
+        const newBody = createCommentBody(
+            commits.data,
+            context.payload.pull_request.title,
+            context.payload.pull_request.body
+        );
         client.rest.issues.createComment({
             owner: context.issue.owner,
             repo: context.issue.repo,
             issue_number: context.issue.number,
             body: newBody,
         });
+        client.rest.reactions.createForIssue({
+            owner: context.issue.owner,
+            repo: context.issue.repo,
+            issue_number: context.issue.number,
+            content: "eyes"
+        });
     }
 }
 

.github/actions/release-changelog-bug-refs/action.yml

@@ -0,0 +1,9 @@
+name: 'Ensure Release Changelog has Bug References'
+description: "Block releases if bug references in commits aren't in the proposed changelog entry"
+inputs:
+  repo-token:
+    description: 'Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
+    required: true
+runs:
+  using: 'node16'
+  main: 'index.js'

.github/actions/release-changelog-bug-refs/index.js

@@ -0,0 +1,44 @@
+const fs = require('fs/promises');
+const core = require('@actions/core');
+const github = require('@actions/github');
+
+async function run() {
+    const context = github.context;
+    if (context.eventName !== "pull_request") {
+      console.log(
+        'The event that triggered this action was not a pull request, skipping.'
+      );
+      return;
+    }
+
+    const client = github.getOctokit(
+        core.getInput('repo-token', {required: true})
+    );
+    const commits = await client.rest.pulls.listCommits({
+        owner: context.issue.owner,
+        repo: context.issue.repo,
+        pull_number: context.issue.number,
+    });
+    let lpBugs = [];
+    let ghIssues = [];
+    commits.data.forEach(commit => {
+        const message = commit.commit.message.toLocaleUpperCase();
+        lpBugs = lpBugs.concat(Array.from(message.matchAll(/LP: #(\d+)/g)).map(m => m[1]));
+        ghIssues = ghIssues.concat(Array.from(message.matchAll(/FIXES: #(\d+)/g)).map(m => m[1]));
+        ghIssues = ghIssues.concat(Array.from(message.matchAll(/CLOSES: #(\d+)/g)).map(m => m[1]));
+    });
+    const changelog = await fs.readFile("./debian/changelog", { encoding: "utf8" });
+    const changelogEntries = changelog.split("ubuntu-advantage-tools");
+    const newEntry = changelogEntries[1];
+    const missingLpBugs = lpBugs.filter(bug => !newEntry.includes(`LP: #${bug}`));
+    const missingGhIssues = ghIssues.filter(issue => !newEntry.includes(`GH: #${issue}`));
+
+    if (missingLpBugs.length > 0 || missingGhIssues.length > 0) {
+        core.setFailed({ missingLpBugs, missingGhIssues });
+    }
+}
+
+run().catch(error => {
+    console.error(error);
+    core.setFailed(error.message);
+})