Skip to content

server.md

Latest commit

 

History

History
38 lines (26 loc) · 1.88 KB

server.md

File metadata and controls

38 lines (26 loc) · 1.88 KB

action: server

action.yaml | Example

action: server creates commits and pull requests.

  1. Download fixed files and metadata from GitHub Actions Artifacts
  2. Get data about associated Workflow Run, Pull Request, and Branch by GitHub API
  3. Validate the request
  4. Create a commit
  5. Create a pull request if it is requested
  6. Update the pull request if it is requested

Inputs

Required Inputs

  • action: Must be server
  • app_id: A GitHub App ID
  • app_private_key: A GitHub App Private Key

Optional Inputs

  • allow_workflow_fix: Either true or false. The default is false. If true, the action can fix workflow files. You need to grant workflows:write permission to the Server GitHub App
  • workflow_name: An expected client workflow name. If the actual client workflow name is different from this input, the request is denied. The default value is securefix. If this is empty, the workflow name is free
  • pull_request_comment: A pull request comment template. A comment is posted if server actions fail to create a commit. The default value is :x: Securefix failed.
  • config: YAML config to push other repositories and branches. Either config or config_file is required if you want to change repositories and branches where commits are pushed
  • config_file: A file path to YAML config to push other repositories and branches. Either config or config_file is required if you want to change repositories and branches where commits are pushed
  • commit_message: A commit message
  • pull_request_comment: A pull request comment template. A comment is posted if server actions fail to create a commit. The default value is ## :x: Securefix failed.

config, config_file

Please see prepare.

Outputs

Nothing.