wp-git-action/docs/data/data.yaml

---
properties:
  - name: action
    description: |
      Git action to execute.

      Supported actions: `clone | commit | push | pages`. Specified actions are executed in the specified order

      - **clone:** Clones the repository in `remote_url` and checks out the `branch` to `path`.
      - **commit:** Adds a commit to the default repository or the repository in `remote_url`.
      - **push:** Pushes all commits to the default repository or the repository set in `remote_url`.
      - **pages:** The `pages` action is a special action that cannot be combined with other actions. It is intended for use for
        GitHub pages. It synchronizes the contents of `pages_directory` with the target `branch` using `rsync` and pushes the changes automatically.
    type: list
    required: true

  - name: author_email
    description: |
      Git author email.
    type: string
    required: true

  - name: author_name
    description: |
      Git author name.
    type: string
    required: true

  - name: branch
    description: |
      Name of the git source branch.
    type: string
    defaultValue: "main"
    required: false

  - name: empty_commit
    description: |
      Allow empty commits.

      Usually recording a commit that has the exact same tree as its sole parent commit is a mistake,
      and those commits are not allowed by default.
    type: bool
    defaultValue: false
    required: false

  - name: followtags
    description: |
      Follow tags for pushes to remote repository.

      Push all the `refs` that would be pushed without this option, and also push annotated tags
      in `refs/tags` that are missing from the remote.
    type: bool
    defaultValue: false
    required: false

  - name: force
    description: |
      Enable force push to remote repository.
    type: bool
    defaultValue: false
    required: false

  - name: insecure_skip_verify
    description: |
      Skip SSL verification.

      Activating this option is insecure and should be avoided in most cases.
    type: bool
    defaultValue: false
    required: false

  - name: log_level
    description: |
      Plugin log level.
    type: string
    defaultValue: "info"
    required: false

  - name: message
    description: |
      Commit message.
    type: string
    defaultValue: "[skip ci] commit dirty state"
    required: false

  - name: netrc_machine
    description: |
      Netrc remote machine name.
    type: string
    defaultValue: "github.com"
    required: false

  - name: netrc_password
    description: |
      Netrc login password on the remote machine.
    type: string
    required: false

  - name: netrc_username
    description: |
      Netrc login user on the remote machine.
    type: string
    defaultValue: "token"
    required: false

  - name: no_verify
    description: |
      Bypass the pre-commit and commit-msg hooks.
    type: bool
    defaultValue: false
    required: false

  - name: pages_delete
    description: |
      Add delete flag to pages rsync command.

      When set to `true`, the `--delete` flag is added to the rsync command to remove files
      from the branch that do not exist in the `pages_directory` either.
    type: bool
    defaultValue: true
    required: false

  - name: pages_directory
    description: |
      Source directory to be synchronized with the pages branch.
    type: string
    defaultValue: "docs/"
    required: false

  - name: pages_exclude
    description: |
      Files or directories to exclude from the pages rsync command.
    type: list
    required: false

  - name: path
    description: |
      Path to clone git repository.
    type: string
    required: false

  - name: remote_url
    description: |
      Url of the remote repository.
    type: string
    required: false

  - name: ssh_key
    description: |
      Ssh private key for the remote repository.
    type: string
    required: false