@useparagon/whiskers-core - npm Package Compare versions

Comparing version 0.0.1-canary.19 to 0.0.1-canary.20

dist/step/step.d.ts

 import { Marshallable } from '../utils/marshallable';
 type BaseParams = {
     /**
-     * whether or not to continue the job if the step fails
+     * Whether or not to continue the job if the step fails
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error
      */
     'continue-on-error'?: boolean | string;
     /**
-     * used to specify an optional step timeout in minutes
+     * A unique identifier for the step. You can use the id to reference the step in contexts.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsid
      */
-    'timeout-minutes'?: number;
+    id?: string;
     /**
-     * the name of the step
+     * You can use the if conditional to prevent a step from running unless a condition is met.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsif
      */
-    name?: string;
+    if?: string;
     /**
-     * the environment variables used within the step
+     * Sets variables for steps to use in the runner environment.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsenv
      */
     env?: Record<string, string | boolean | number>;
     /**
-     * a unique identifier for the step; has to be unique within a job but not globally
+     * A name for your step to display on GitHub.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsname
      */
-    id?: string;
+    name?: string;
     /**
-     * if provided, it specifies conditions in which the step should run
+     * Used to specify an optional step timeout in minutes
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes
      */
-    if?: string;
+    'timeout-minutes'?: number;
 };
@@ -34,4 +46,18 @@ /**
      * Runs command-line programs using the operating system's shell.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
      */
     run: string;
+    /**
+     * Override the default shell settings in the runner's operating system.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell
+     */
+    shell?: string;
+    /**
+     * Using the working-directory keyword, you can specify the working directory of where to run the command.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsworking-directory
+     */
+    'working-directory'?: string;
 };
@@ -47,2 +73,4 @@ /**
      *  - `./.github/workflows/{filename}` for reusable workflows in the same repository.
+     *
+     * @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses
      */
@@ -49,0 +77,0 @@ uses: string;

package.json

 {
   "name": "@useparagon/whiskers-core",
-  "version": "0.0.1-canary.19",
+  "version": "0.0.1-canary.20",
   "bugs": "https://github.com/useparagon/whiskers/issues",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/useparagon/whiskers#readme",

No alert changes

Improved metrics

Total package byte prevSize

56511

increased by2.95%

Lines of code

1199

increased by2.39%

No dependency changes