autogits/workflow-pr/README.md
2024-09-30 15:28:25 +02:00

1.0 KiB

Workflow-PR bot

Keeps ProjectGit PR in-sync with a PackageGit PR

Areas of Responsibility

  • Detects a PackageGit PR creation against a package and creates a coresponsing PR against the ProjectGit
  • When a PackageGit PR is updated, the corresponding PR against the ProjectGit is updated
  • Stores reference to the PackageGit PR in the headers of the ProjectGit PR comments, for later reference
    • this allows ProjectGit PR to be merged to seperated later (via another tool, for example)
  • Initiates all staging workflows via review requests

Target Usage

Any project (devel, etc) that accepts PR

Config file

JSON

  • Workflows: "pr" -- pr workflow enabled
  • Organization: organization that holds all the packages
  • Branch: branch updated in repo's
  • GitProjectName: package in above org, or org/package for PrjGit

example:

{
    "Workflows": ["pr", "direct"],
    "Organization": "autogits",
    "GitProjectName": "HiddenPrj",
    "Branch": "hidden"
},