ci(release): Add githubRelease option and handle executing in CI context

Author: minwork

.github/workflows/release.yml

@@ -19,6 +19,11 @@ on:
         type: boolean
         required: false
         default: true
+      github-release:
+        description: Whether or not to create Github release (doing so will require pushing changes)
+        type: boolean
+        required: false
+        default: true
 
 env:
   FORCE_COLOR: 2
@@ -71,7 +76,7 @@ jobs:
           git config user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
 
       - name: Release packages on '${{ inputs.channel }}' channel
-        run: yarn release -c ${{ inputs.channel }} --verbose ${{ inputs.publish-only && '--publishOnly' }} ${{ inputs.skip-publish && '--skipPublish' }}
+        run: yarn release -c ${{ inputs.channel }} --verbose ${{ inputs.publish-only && '--publishOnly' }} ${{ inputs.skip-publish && '--skipPublish' }} ${{ inputs.github-release && '--githubRelease'}}
         env:
           RELEASE_ENABLED: ${{ vars.RELEASE_ENABLED }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

tools/scripts/release/changelog.ts

@@ -5,12 +5,7 @@ import { isPrereleaseVersion } from './version';
 import chalk from 'chalk';
 import { HandleChangelogOptions } from './changelog.types';
 
-export async function handleChangelog({
-  projectName,
-  isPrerelease,
-  isCI,
-  options,
-}: HandleChangelogOptions): Promise<void> {
+export async function handleChangelog({ projectName, isPrerelease, options }: HandleChangelogOptions): Promise<void> {
   // Option to explicitly specify scope of the changelog
   let from: string | undefined;
   const currentVersion = options.versionData[projectName].currentVersion;
@@ -61,7 +56,5 @@ export async function handleChangelog({
     ...options,
     projects: [projectName],
     from,
-    // If in CI environment then commits need to be pushed
-    gitPush: isCI,
   });
 }

tools/scripts/release/changelog.types.ts

@@ -3,6 +3,5 @@ import { ChangelogOptions as NxChangelogOptions } from 'nx/src/command-line/rele
 export interface HandleChangelogOptions {
   projectName: string;
   isPrerelease: boolean;
-  isCI: boolean;
   options: NxChangelogOptions;
 }

tools/scripts/release/cli.ts

@@ -50,8 +50,14 @@ export function parseReleaseCliOptions() {
     })
     .option('ci', {
       type: 'boolean',
-      default: false,
       describe: 'Whether or not to run in CI context.',
+      demandOption: false,
+    })
+    .option('githubRelease', {
+      type: 'boolean',
+      alias: 'ghr',
+      default: false,
+      describe: 'Whether or not to create Github release (doing so will require pushing changes)',
     })
     .parseAsync();
 }
@@ -60,6 +66,7 @@ export function parseReleaseOptions({
   channel,
   dryRun,
   ci,
+  verbose,
 }: Awaited<ReturnType<typeof parseReleaseCliOptions>>): ParsedOptions {
   let isPrerelease: boolean;
   let preid: ReleasePreidValue;
@@ -103,12 +110,14 @@ export function parseReleaseOptions({
   );
 
   const isCI = ci ?? isNxCI();
+  console.log('CI', ci, isCI);
 
   return {
     isPrerelease,
     preid,
     tag,
     dryRun: dryRun || !releaseEnabled,
+    verbose: isCI || verbose,
     isCI,
   };
 }

tools/scripts/release/cli.types.ts

@@ -3,7 +3,8 @@ import { ReleaseChannel } from './release.consts';
 export interface ParsedOptions {
   isPrerelease: boolean;
   isCI: boolean;
-  preid?: string;
+  preid: string | undefined;
   tag: ReleaseChannel;
-  dryRun?: boolean;
+  dryRun: boolean;
+  verbose: boolean;
 }

tools/scripts/release/release.ts

@@ -13,8 +13,8 @@ import { handleChangelog } from './changelog';
 (async () => {
   const options = await parseReleaseCliOptions();
   const graph = await createProjectGraphAsync({ exitOnError: true });
-  const { publishOnly, projects, verbose, otp, skipPublish } = options;
-  const { tag, preid, isPrerelease, dryRun, isCI } = parseReleaseOptions(options);
+  const { publishOnly, projects, otp, skipPublish, githubRelease } = options;
+  const { tag, preid, isPrerelease, dryRun, isCI, verbose } = parseReleaseOptions(options);
 
   const projectsList = new Set(projects ?? []);
 
@@ -79,12 +79,12 @@ import { handleChangelog } from './changelog';
         await handleChangelog({
           projectName,
           isPrerelease,
-          isCI,
           options: {
             versionData,
             dryRun,
             verbose,
-            createRelease: 'github',
+            createRelease: githubRelease ? 'github' : undefined,
+            gitPush: githubRelease || isCI ? true : undefined,
           },
         });
         // Add this project to projects list that will be published