18F / methods

The methods 18F uses to practice human-centered design.

Home Page:https://methods.18f.gov/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create automatic reminders to update other repos when editing issue/PR templates

mgwalker opened this issue · comments

Background

Follow-on from #576. This PR is to create an automation that will run whenever an issue or pull request template is modified. That automation will check related repos (e.g., ux-guide) to see if those repos have already been updated with the same template. If they have not, the automation should open a pull request on those repos with the necessary update. That way, the people working on these projects don't have to always remember to synchronize templates or manually do the work – a computer will remind them and do most of the work for them.

The synchronization cannot be 100% automated because the main branch of this repo is protected and cannot be pushed to directly. (The other repos should have similar restrictions, but they don't yet.) As a result, the automation has to wait for someone to approve and merge the changes.

Acceptance criteria (we'll know we're done when…)

  • Creating or editing an issue or pull request template triggers the automation
  • The automation opens an appropriate pull request on other repos if their templates are not the same
  • The automation does not open a pull request on another repo if the other repo's templates are already the same

Tasks

  • Create an automation that triggers when templates are changed
  • Modify the automation so that it identifies only the templates changed
  • Modify the automation so that it checks the other repos to see if they should be synced
  • Modify the automation so that it opens pull requests on the other repos, if appropriate

Look into this action, which might already satisfy our needs: https://github.com/BetaHuhn/repo-file-sync-action

Closed by #597