Release 0.0.1

.github/workflows/post-release.yml

@@ -22,7 +22,13 @@ jobs:
           develop_branch: "develop"
           main_branch: "main"
           # if you want to post to slack
-          slack_channel: "hoang-test"
+          slack: >
+            {
+              "channel": "hoang-test",
+              "username_mapping": {
+                "hoangvvo": "U03B3E4UPV3"
+              }
+            }
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           # if you want to post to slack

README.md

@@ -74,7 +74,30 @@ You should have your own deployment workflow as this action will not handle it.
 
 ### Post to Slack
 
-It is often that an anouncement is made to a Slack channel after a release. To do so, specify `SLACK_TOKEN` env and `slack_channel` input.
+It is often that an anouncement is made to a Slack channel after a release. To do so, specify `SLACK_TOKEN` env and `slack` input.
+
+```yaml
+jobs:
+  post_release:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    name: Post Release
+    steps:
+      - name: gitflow-workflow-action post-release
+        uses: hoangvvo/gitflow-workflow-action@v0
+        with:
+          develop_branch: "develop"
+          main_branch: "main"
+          slack: >
+            {
+              "channel": "hoang-test",
+              "username_mapping": {
+                "hoangvvo": "U03B3E4UPV3"
+              }
+            }
+        env:
+          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
+```
 
 ## License
 

action.yml

@@ -1,5 +1,5 @@
-name: "Git Workflow Release Action"
-description: "Create a Deploy to Production pull request with changelog"
+name: "Git Workflow Action"
+description: "Create PR for release + Create GH release and send Slack message on merge"
 
 inputs:
   version:
@@ -12,9 +12,10 @@ inputs:
   main_branch:
     description: The branch that would release to production
     required: true
-  slack_channel:
-    description: The slack channel to post the release message to
+  slack:
+    description: The slack options (channel, name mapping)
     required: false
+
 runs:
   using: "node16"
   main: "dist/index.js"

dist/index.js

@@ -19091,6 +19091,11 @@ const { WebClient: SlackWebClient } = __nccwpck_require__(431);
 const { Config, octokit } = __nccwpck_require__(9297);
 
 exports.executePostRelease = async function executePostRelease() {
+  /**
+   * Precheck
+   * Check if the pull request has a release label, targeting main branch, and if it was merged
+   */
+
   if (github.context.eventName !== "pull_request") {
     console.log(`Not a pull request merge. Exiting...`);
     return;
@@ -19109,7 +19114,7 @@ exports.executePostRelease = async function executePostRelease() {
   });
 
   if (pullRequest.base.ref !== Config.prodBranch) {
-    console.log("Request does not merge to main_branch. Exiting...");
+    console.log("PR does not merge to main_branch. Exiting...");
     return;
   }
 
@@ -19123,12 +19128,13 @@ exports.executePostRelease = async function executePostRelease() {
     return;
   }
 
-  // release branch always has the format
-  // `release/${version}`
   const releaseBranch = pullRequest.head.ref;
   const version = releaseBranch.substring("release/".length);
 
-  // Merge back to develop branch
+  /**
+   * Merging the release branch back to the develop branch if needed
+   */
+
   const { data: compareCommitsResult } =
     await octokit.rest.repos.compareCommits({
       ...Config.repo,
@@ -19167,33 +19173,59 @@ exports.executePostRelease = async function executePostRelease() {
     );
   }
 
-  // Create a release
-  console.log(`Creating a release`);
-  const { data: release } = await octokit.rest.repos.createRelease({
+  /**
+   * Creating a release
+   */
+
+  console.log(`Creating release ${version}`);
+  const { data: latestRelease } = await octokit.rest.repos
+    .getLatestRelease(Config.repo)
+    .catch(() => ({ data: null }));
+
+  const { data: releaseNotes } = await octokit.rest.repos.generateReleaseNotes({
+    ...Config.repo,
+    tag_name: version,
+    target_commitish: Config.developBranch,
+    previous_tag_name: latestRelease?.tag_name,
+  });
+
+  await octokit.rest.repos.createRelease({
     ...Config.repo,
     tag_name: version,
     target_commitish: Config.prodBranch,
-    generate_release_notes: true,
+    body: releaseNotes.body,
   });
 
-  // Post to slack if needed
-  const slackChannel = core.getInput("slack_channel");
-  if (slackChannel) {
-    console.log(`Posting to slack channel #${slackChannel}`);
+  /**
+   * Slack integration
+   */
+
+  const slackStr = core.getInput("slack");
+  if (slackStr) {
+    const slackOpts = JSON.parse("slack");
+
+    console.log(`Posting to slack channel #${slackOpts.channel}`);
     const slackToken = process.env.SLACK_TOKEN;
     if (!slackToken) throw new Error("process.env.SLACK_TOKEN is not defined");
+
     const slackWebClient = new SlackWebClient(slackToken);
 
+    const username_mapping = slackOpts["username_mapping"] || {};
+
+    let releaseBody = releaseNotes.body;
+
+    for (const [username, slackUserId] of Object.entries(username_mapping)) {
+      releaseBody = releaseBody.replaceAll(`@${username}`, `<@${slackUserId}>`);
+    }
+
     await slackWebClient.chat.postMessage({
-      text: `*Release ${version} to ${Config.repo.owner}/${Config.repo.repo}*
+      text: `*[Release ${version} to ${Config.repo.owner}/${Config.repo.repo}](${pullRequest.url})*
 
-${release.body}`,
-      channel: slackChannel,
+      ${releaseBody}`,
+      channel: slackOpts.channel,
       icon_url: "https://avatars.githubusercontent.com/in/15368?s=88&v=4",
     });
   }
-
-  // Merge back to develop branch
 };
 
 
@@ -19213,12 +19245,18 @@ exports.createReleasePR = async function createReleasePR() {
   if (!version) throw new Error(`Missing input.version`);
 
   console.log(`Generating release notes`);
+
   // developBranch and mainBranch are almost identical
   // so we can use developBranch for ahead-of-time release note
+  const { data: latestRelease } = await octokit.rest.repos
+    .getLatestRelease(Config.repo)
+    .catch(() => ({ data: null }));
+
   const { data: releaseNotes } = await octokit.rest.repos.generateReleaseNotes({
     ...Config.repo,
     tag_name: version,
     target_commitish: Config.developBranch,
+    previous_tag_name: latestRelease?.tag_name,
   });
 
   console.log(`Creating release branch`);

index.js

@@ -0,0 +1 @@
+fetch();

package.json

@@ -25,6 +25,7 @@
     "@slack/web-api": "^6.7.2"
   },
   "devDependencies": {
+    "@tsconfig/node18": "^1.0.1",
     "@types/node": "^18.7.13",
     "@vercel/ncc": "^0.34.0",
     "eslint": "^8.23.0",

src/post-release.js

@@ -5,6 +5,11 @@ const { WebClient: SlackWebClient } = require("@slack/web-api");
 const { Config, octokit } = require("./shared.js");
 
 exports.executePostRelease = async function executePostRelease() {
+  /**
+   * Precheck
+   * Check if the pull request has a release label, targeting main branch, and if it was merged
+   */
+
   if (github.context.eventName !== "pull_request") {
     console.log(`Not a pull request merge. Exiting...`);
     return;
@@ -23,7 +28,7 @@ exports.executePostRelease = async function executePostRelease() {
   });
 
   if (pullRequest.base.ref !== Config.prodBranch) {
-    console.log("Request does not merge to main_branch. Exiting...");
+    console.log("PR does not merge to main_branch. Exiting...");
     return;
   }
 
@@ -37,12 +42,13 @@ exports.executePostRelease = async function executePostRelease() {
     return;
   }
 
-  // release branch always has the format
-  // `release/${version}`
   const releaseBranch = pullRequest.head.ref;
   const version = releaseBranch.substring("release/".length);
 
-  // Merge back to develop branch
+  /**
+   * Merging the release branch back to the develop branch if needed
+   */
+
   const { data: compareCommitsResult } =
     await octokit.rest.repos.compareCommits({
       ...Config.repo,
@@ -81,31 +87,57 @@ exports.executePostRelease = async function executePostRelease() {
     );
   }
 
-  // Create a release
-  console.log(`Creating a release`);
-  const { data: release } = await octokit.rest.repos.createRelease({
+  /**
+   * Creating a release
+   */
+
+  console.log(`Creating release ${version}`);
+  const { data: latestRelease } = await octokit.rest.repos
+    .getLatestRelease(Config.repo)
+    .catch(() => ({ data: null }));
+
+  const { data: releaseNotes } = await octokit.rest.repos.generateReleaseNotes({
+    ...Config.repo,
+    tag_name: version,
+    target_commitish: Config.developBranch,
+    previous_tag_name: latestRelease?.tag_name,
+  });
+
+  await octokit.rest.repos.createRelease({
     ...Config.repo,
     tag_name: version,
     target_commitish: Config.prodBranch,
-    generate_release_notes: true,
+    body: releaseNotes.body,
   });
 
-  // Post to slack if needed
-  const slackChannel = core.getInput("slack_channel");
-  if (slackChannel) {
-    console.log(`Posting to slack channel #${slackChannel}`);
+  /**
+   * Slack integration
+   */
+
+  const slackStr = core.getInput("slack");
+  if (slackStr) {
+    const slackOpts = JSON.parse("slack");
+
+    console.log(`Posting to slack channel #${slackOpts.channel}`);
     const slackToken = process.env.SLACK_TOKEN;
     if (!slackToken) throw new Error("process.env.SLACK_TOKEN is not defined");
+
     const slackWebClient = new SlackWebClient(slackToken);
 
+    const username_mapping = slackOpts["username_mapping"] || {};
+
+    let releaseBody = releaseNotes.body;
+
+    for (const [username, slackUserId] of Object.entries(username_mapping)) {
+      releaseBody = releaseBody.replaceAll(`@${username}`, `<@${slackUserId}>`);
+    }
+
     await slackWebClient.chat.postMessage({
-      text: `*Release ${version} to ${Config.repo.owner}/${Config.repo.repo}*
+      text: `*[Release ${version} to ${Config.repo.owner}/${Config.repo.repo}](${pullRequest.url})*
 
-${release.body}`,
-      channel: slackChannel,
+      ${releaseBody}`,
+      channel: slackOpts.channel,
       icon_url: "https://avatars.githubusercontent.com/in/15368?s=88&v=4",
     });
   }
-
-  // Merge back to develop branch
 };

src/pre-release.js

@@ -9,12 +9,18 @@ exports.createReleasePR = async function createReleasePR() {
   if (!version) throw new Error(`Missing input.version`);
 
   console.log(`Generating release notes`);
+
   // developBranch and mainBranch are almost identical
   // so we can use developBranch for ahead-of-time release note
+  const { data: latestRelease } = await octokit.rest.repos
+    .getLatestRelease(Config.repo)
+    .catch(() => ({ data: null }));
+
   const { data: releaseNotes } = await octokit.rest.repos.generateReleaseNotes({
     ...Config.repo,
     tag_name: version,
     target_commitish: Config.developBranch,
+    previous_tag_name: latestRelease?.tag_name,
   });
 
   console.log(`Creating release branch`);

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@tsconfig/node18/tsconfig.json",
+  "compilerOptions": {
+    "lib": ["es2022", "DOM"],
+    "outDir": "dist",
+    "rootDir": "./src",
+    "allowJs": true
+  },
+  "include": ["./src/**/*"]
+}