Add reminder to minimise code outside try/catch

Author: henrymercer

src/analyze-action-post.ts

@@ -21,6 +21,9 @@ import { getActionsLogger } from "./logging";
 import { checkGitHubVersionInRange, getErrorMessage } from "./util";
 
 async function runWrapper() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   try {
     actionsUtil.restoreInputs();
     const logger = getActionsLogger();

src/analyze-action.ts

@@ -209,6 +209,9 @@ async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
 }
 
 async function run() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
   let uploadResults:
     | Partial<Record<analyses.AnalysisKind, UploadResult>>

src/autobuild-action.ts

@@ -69,6 +69,9 @@ async function sendCompletedStatusReport(
 }
 
 async function run() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
   const logger = getActionsLogger();
   let config: Config | undefined;

src/init-action-post.ts

@@ -42,6 +42,9 @@ interface InitPostStatusReport
     initActionPostHelper.DependencyCachingUsageReport {}
 
 async function runWrapper() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const logger = getActionsLogger();
   const startedAt = new Date();
   let config: Config | undefined;

src/init-action.ts

@@ -192,6 +192,9 @@ async function sendCompletedStatusReport(
 }
 
 async function run() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
   const logger = getActionsLogger();
 

src/resolve-environment-action.ts

@@ -30,6 +30,9 @@ import {
 const ENVIRONMENT_OUTPUT_NAME = "environment";
 
 async function run() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
   const logger = getActionsLogger();
 

src/setup-codeql-action.ts

@@ -86,6 +86,9 @@ async function sendCompletedStatusReport(
 
 /** The main behaviour of this action. */
 async function run(): Promise<void> {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
   const logger = getActionsLogger();
 

src/start-proxy-action-post.ts

@@ -13,6 +13,9 @@ import { getActionsLogger } from "./logging";
 import { checkGitHubVersionInRange, getErrorMessage } from "./util";
 
 async function runWrapper() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const logger = getActionsLogger();
 
   try {

src/start-proxy-action.ts

@@ -123,6 +123,9 @@ async function sendSuccessStatusReport(
 }
 
 async function runWrapper() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   const startedAt = new Date();
 
   const logger = getActionsLogger();

src/upload-sarif-action-post.ts

@@ -13,6 +13,9 @@ import { getActionsLogger, withGroup } from "./logging";
 import { checkGitHubVersionInRange, getErrorMessage } from "./util";
 
 async function runWrapper() {
+  // To capture errors appropriately, keep as much code within the try-catch as
+  // possible, and only use safe functions outside.
+
   try {
     // Restore inputs from `upload-sarif` Action.
     actionsUtil.restoreInputs();