fix: Add comments

Author: koki-develop

lib/package/concurrency.ts

@@ -3,6 +3,12 @@ import type { Expression } from "./expression";
 export type Concurrency =
   | string
   | {
+      /**
+       * When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.
+       */
       group: string;
+      /**
+       * To cancel any currently running job or workflow in the same concurrency group, specify true.
+       */
       cancelInProgress?: boolean | Expression;
     };

lib/package/container.ts

@@ -1,13 +1,38 @@
 import type { Env } from "./env";
 
 export type Container = {
+  /**
+   * The Docker image to use as the container to run the action.
+   * The value can be the Docker Hub image name or a registry name.
+   */
   image: string;
+  /**
+   * If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password.
+   * The credentials are the same values that you would provide to the `docker login` command.
+   */
   credentials?: {
     username?: string;
     password?: string;
   };
+  /**
+   * Sets an array of environment variables in the container.
+   */
   env?: Env;
+  /**
+   * Sets an array of ports to expose on the container.
+   */
   ports?: (number | string)[];
+  /**
+   * Sets an array of volumes for the container to use.
+   * You can use volumes to share data between services or other steps in a job.
+   * You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.
+   * To specify a volume, you specify the source and destination path: <source>:<destinationPath>
+   * The <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.
+   */
   volumes?: string[];
+  /**
+   * Additional Docker container resource options.
+   * @see https://docs.docker.com/engine/reference/commandline/create/#options.
+   */
   options?: string;
 };

lib/package/env.ts

@@ -1,3 +1,8 @@
+/**
+ * To set custom environment variables, you need to specify the variables in the workflow file.
+ * You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords.
+ * @see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv
+ */
 export type Env = {
   [key: string]: string;
 };

lib/package/environment.ts

@@ -1,6 +1,15 @@
+/**
+ * The environment that the job references.
+ */
 export type Environment =
   | string
   | {
+      /**
+       * The name of the environment configured in the repo.
+       */
       name: string;
+      /**
+       * A deployment URL.
+       */
       url?: string;
     };

lib/package/job.ts

@@ -18,23 +18,90 @@ import { type RunStep, type Step, type UsesStep } from "./step";
 import type { Strategy } from "./strategy";
 
 type JobConfigBase = {
+  /**
+   * The name of the job displayed on GitHub.
+   */
   name?: string;
+  /**
+   * Identifies any jobs that must complete successfully before this job will run.
+   * It can be a string or array of strings.
+   * If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.
+   */
   needs?: string | string[];
   permissions?: Permissions;
+  /**
+   * You can use the if conditional to prevent a job from running unless a condition is met.
+   * You can use any supported context and expression to create a conditional.
+   * Expressions in an if conditional do not require the ${{ }} syntax.
+   * @see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.
+   */
   if?: string | boolean;
+  /**
+   * A strategy creates a build matrix for your jobs.
+   * You can define different variations of an environment to run each job in.
+   */
   strategy?: Strategy;
+  /**
+   * Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
+   * A concurrency group can be any string or expression.
+   * The expression can use any context except for the secrets context.
+   * You can also specify concurrency at the workflow level.
+   * When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending.
+   * Any previously pending job or workflow in the concurrency group will be canceled.
+   * To also cancel any currently running job or workflow in the same concurrency group, specify `cancelInProgress: true`.
+   */
   concurrency?: Concurrency;
 };
 
 export type NormalJobConfig = JobConfigBase & {
+  /**
+   * The type of machine to run the job on.
+   * The machine can be either a GitHub-hosted runner, or a self-hosted runner.
+   */
   runsOn: RunsOn;
+  /**
+   * The environment that the job references.
+   */
   environment?: Environment;
+  /**
+   * A map of outputs for a job.
+   * Job outputs are available to all downstream jobs that depend on this job.
+   */
   outputs?: Record<string, string>;
+  /**
+   * A map of environment variables that are available to all steps in the job.
+   */
   env?: Env;
+  /**
+   * A map of default settings that will apply to all steps in the job.
+   */
   defaults?: Defaults;
+  /**
+   * The maximum number of minutes to let a workflow run before GitHub automatically cancels it.
+   * @default 360
+   */
   timeoutMinutes?: number | Expression;
+  /**
+   * Prevents a workflow run from failing when a job fails.
+   * Set to true to allow a workflow run to pass when this job fails.
+   */
   continueOnError?: boolean | Expression;
+  /**
+   * A container to run any steps in a job that don't already specify a container.
+   * If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.
+   * If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.
+   */
   container?: Container;
+  /**
+   * Additional containers to host services for a job in a workflow.
+   * These are useful for creating databases or cache services like redis.
+   * The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.
+   * When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service.
+   * Docker automatically exposes all ports between containers on the same network.
+   * When both the job and the action run in a container, you can directly reference the container by its hostname.
+   * The hostname is automatically mapped to the service name.
+   * When a step does not use a container action, you must access the service using localhost and bind the ports.
+   */
   services?: Record<string, Container>;
 };
 

lib/package/matrix.ts

@@ -1,5 +1,15 @@
 import type { Expression } from "./expression";
 
+/**
+ * A build matrix is a set of different configurations of the virtual environment.
+ * For example you might run a job against more than one supported version of a language, operating system, or tool.
+ * Each configuration is a copy of the job that runs and reports a status.
+ * You can specify a matrix by supplying an array for the configuration options.
+ * For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.
+ * When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name.
+ * To access the operating system name, you can use the matrix.os context parameter to set runs-on.
+ * @see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.
+ */
 export type Matrix =
   | Expression
   | { [key: string]: Expression | Configuration[] }