conditional-paths-action API Documentation - v1.0.0
    Preparing search index...
    • Reads and validates all action inputs from the GitHub Actions environment.

      This function:

      1. Reads raw input values from the GitHub Actions environment
      2. Converts string inputs to appropriate types (numbers, etc.)
      3. Validates all inputs against the defined schema
      4. Returns type-safe, validated input objects

      Returns {
          workingDirectory?: string;
          token?: string;
          ref?: string;
          base?: string;
          filters: string;
          listFiles: "none" | "csv" | "json" | "shell" | "escape";
          initialFetchDepth: number;
          predicateQuantifier: "every" | "some";
      }

      Validated action inputs with proper types

      • OptionalworkingDirectory?: string

        Relative path where the repository was checked out

      • Optionaltoken?: string

        GitHub token for API access

      • Optionalref?: string

        Git reference to detect changes from

      • Optionalbase?: string

        Git reference to compare against

      • filters: string

        Path filters configuration (YAML string or file path)

      • listFiles: "none" | "csv" | "json" | "shell" | "escape"

        Format for outputting matched file lists

      • initialFetchDepth: number

        Initial number of commits to fetch for merge-base detection

      • predicateQuantifier: "every" | "some"

        Logic quantifier for multiple pattern matching

      When inputs are invalid or missing required values

      try {
      const inputs = getInputs()
      console.log(inputs.filters) // Type-safe string access
      console.log(inputs.initialFetchDepth) // Type-safe number access
      } catch (error) {
      console.error('Invalid inputs:', error.message)
      }