Crate gh_workflow

Modules

• ctx
  A type-safe implementation of workflow context: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs
• error
  This module defines the Error enum and the Result type alias used throughout the crate.
• generate
  This module provides functionality to customize generation of the GitHub Actions workflow files.
• release_plz
  A typed representation of the release-plz action in a GitHub workflow. Docs: https://github.com/release-plz/action
• toolchain
  The typed version of the setup-rust-toolchain action in a GitHub workflow. Docs: https://github.com/actions-rust-lang/setup-rust-toolchain

Structs

• Artifact
  Represents an artifact produced by a job.
• Artifacts
  Represents artifacts produced by jobs.
• BranchProtectionRule
  Configuration for branch protection rule events
• Cargo
• CheckRun
• CheckSuite
  Configuration for check suite events
• Concurrency
  Represents concurrency settings for workflows.
• Container
  Represents a container configuration for jobs.
• Create
  Configuration for create events (branch or tag creation) See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#create
• Credentials
  Represents credentials for accessing a container.
• Defaults
  Represents default settings for jobs.
• Delete
  Configuration for delete events (branch or tag deletion) See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#delete
• Deployment
  Types of deployment events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment
• DeploymentStatus
  Types of deployment status events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment_status
• Discussion
  Configuration for discussion events
• DiscussionComment
  Configuration for discussion comment events
• Env
  Represents environment variables in the workflow.
• Environment
  Represents an environment for jobs.
• Event
  Represents all possible webhook events that can trigger a workflow See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
• EventAction
  Represents an action that can be triggered by an event in the workflow.
• Expression
  Represents an expression used in conditions.
• Input
  Represents input parameters for a step.
• IssueComment
  Configuration for issue comment events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment
• Issues
  Configuration for issue events
• Job
  Represents a job in the workflow.
• Jobs
• Label
  Configuration for label events
• MergeGroup
• Milestone
• Permissions
  Represents permissions for the GITHUB_TOKEN.
• PullRequest
• PullRequestReview
  Configuration for pull request review events
• PullRequestReviewComment
  Configuration for pull request review comment events
• PullRequestTarget
  Configuration for pull request target events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
• Push
  Configuration for push events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push
• RegistryPackage
  Configuration for registry package events
• Release
  Configuration for release events
• RepositoryDispatch
• RetryDefaults
  Represents default settings for retries.
• RetryStrategy
  Represents a strategy for retrying jobs.
• Run
  Represents a step that runs a command.
• RunDefaults
  Represents default settings for running commands.
• RunsOn
  Represents the environment in which a job runs.
• Schedule
• Secret
  Represents a secret required for the workflow.
• Step
  Represents a step in the workflow.
• StepValue
  Represents a step value in the workflow.
• Strategy
  Represents the strategy for running jobs.
• Use
  Represents a step that uses an action.
• Volume
  Represents a volume configuration for containers.
• Watch
• Workflow
  Represents the configuration for a GitHub workflow.
• WorkflowCall
  Configuration for workflow call events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_call
• WorkflowCallInput
  Configuration for workflow call input
• WorkflowCallOutput
  Configuration for workflow call output
• WorkflowCallSecret
  Configuration for workflow call secret
• WorkflowDispatch
  Configuration for workflow dispatch events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
• WorkflowDispatchInput
  Configuration for workflow dispatch input
• WorkflowRun
  Configuration for workflow run events

Enums

• ActivityType
  Represents the type of activity in the workflow.
• BranchProtectionRuleType
  Types of branch protection rule events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#branch_protection_rule
• CheckRunType
  Types of check run events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_run
• CheckSuiteType
  Types of check suite events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_suite
• DiscussionCommentType
  Types of discussion comment events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#discussion_comment
• DiscussionType
  Types of discussion events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#discussion
• IssueCommentType
  Types of issue comment events
• IssuesType
  Types of issue events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues
• LabelType
  Types of label events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#label
• Level
  Represents the level of permissions.
• Lint
• MergeGroupType
• MilestoneType
• Port
  Represents a network port.
• PullRequestReviewCommentType
  Types of pull request review comment events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_review_comment
• PullRequestReviewType
  Types of pull request review events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_review
• PullRequestType
• RegistryPackageType
  Types of registry package events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#registry_package
• ReleaseType
  Types of release events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
• Runner
  Represents the runner environment for jobs.
• RustFlags
• WorkflowRunType
  Types of workflow run events See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run

Traits

• StepType
  A trait to convert Step<Run> and Step<Use> to StepValue.