Skip to content

CONFIGURATION.md

Latest commit

 

History

History
133 lines (102 loc) · 5.87 KB

CONFIGURATION.md

File metadata and controls

133 lines (102 loc) · 5.87 KB
Raw

Configuration Reference

Complete reference for all available configuration options.


Table of Contents

Required Inputs

Input Description Example
user_email Git user email actions@github.com
user_name Git user name GitHub Actions

Optional Inputs


Commit Settings

Input Description Default
commit_message Commit message Auto commit by Go Git Commit Action
branch Branch to push to main
repository_path Path to the repository .
file_pattern File pattern to add .
skip_if_empty Skip if no changes false
rebase_on_reject Rebase onto the remote branch and retry when a push finds the remote ahead false

Notes:

  • file_pattern supports multiple space-separated patterns: "*.md *.txt"
  • repository_path is relative to the workspace root
  • The action fails, rather than commit and push nothing, when changes are staged while branch names a local branch other than the one checked out, or while HEAD is detached. With nothing staged it carries on. A tag-only step commits nothing, so this check does not apply to it
  • rebase_on_reject is for a job that can run while someone else pushes to the same branch. It acts only after a rejected push, and only when the remote has moved forward from the commit's parent, so a push that succeeds never rebases and an authentication failure is left alone. It applies to the branch input, not to the branch auto_branch creates, and needs retry_count of at least 2
  • With rebase_on_reject, the action fails as it does without the input, and never force-pushes, when: the rebase conflicts; a tracked file outside file_pattern has uncommitted changes (there is no autostash, because a stash that cannot be reapplied leaves conflict markers while git reports success); the remote's history was rewritten, so the commit's parent is gone from it; or the job holds other unpushed commits
  • The published commit sits on a remote state the workflow did not test, so leave rebase_on_reject off if later steps depend on the exact tree. If the remote already has the identical change, the rebase drops the commit, and commit_sha reports the remote's commit

Tag Settings

Input Description Default
tag_name Tag name to create or delete -
tag_message Tag message (for annotated tags) -
delete_tag Whether to delete the tag false
tag_reference Git reference for the tag -

Notes:

  • Tag operations only execute when tag_name is provided
  • A tag step that sets none of file_pattern, commit_message, create_pr, skip_if_empty or rebase_on_reject commits nothing. Setting file_pattern or commit_message to its default value counts as not setting it. skipped stays false, changed_files is 0 and commit_sha is HEAD
  • Unless tag_reference is set, the tag lands on HEAD. A branch that exists only on the remote is checked out first, so its tip is tagged; a local branch is not switched to, and the action warns when HEAD is off it or holds unpushed commits. A branch that exists nowhere is created and pushed, so set branch on a repository whose default is not main
  • delete_tag with a tag_name commits and pushes nothing: file_pattern, commit_message and create_pr are ignored with a warning, skipped is true, changed_files is 0 and commit_sha is empty
  • tag_reference can be a commit SHA, tag name, or branch name
  • tag_reference cannot be used with delete_tag

Pull Request Settings

Input Description Default
create_pr Whether to create a pull request false
auto_branch Whether to create automatic branch false
pr_title Pull request title Auto PR by Go Git Commit Action
pr_base Base branch for pull request main
pr_branch Branch to create pull request from -
delete_source_branch Delete source branch after PR false
github_token GitHub token for PR creation -
pr_labels Labels (comma-separated) -
pr_body Custom body message -
pr_closed Close PR after creation false
pr_dry_run Simulate PR creation false

Notes:

  • github_token is required when create_pr is true
  • pr_branch is required when create_pr is true and auto_branch is false
  • pr_base is required when create_pr is true
  • When auto_branch is true, creates branch with format: update-files-{timestamp}
  • When pr_dry_run and auto_branch are both true, only the branch name is generated: no branch is created, nothing is committed or pushed, the changed-file preview lists the uncommitted changes that file_pattern would stage, and no pull request is opened
  • delete_source_branch only works with auto_branch: true

Default Values

commit_message: "Auto commit by Go Git Commit Action"
branch: "main"
repository_path: "."
file_pattern: "."
skip_if_empty: false
rebase_on_reject: false
delete_tag: false
create_pr: false
auto_branch: false
pr_base: "main"
delete_source_branch: false
pr_closed: false
pr_dry_run: false

Input Validation

The action validates inputs before execution:


PR Creation Validation

  • pr_branch must be set when auto_branch is false
  • pr_base must be set when create_pr is true
  • github_token must be set when create_pr is true

Tag Validation

  • tag_reference cannot be used with delete_tag

File Pattern Validation

  • Multiple patterns separated by spaces
  • Standard git pattern matching supported