README.md

org-wide-files

How it works

On each push to the main branch, all files in global-files/ will be copied to all Exercism repos. The files in tooling-files and tracks-files will be copied to all tooling and track repos respectively. Tooling and track repos are determined by their exercism-tooling and exercism-track topic. A PR will be opened on each repo, which will (in the future) be automatically merged by a webhook integration.

After pushing, you have 5 minutes to abort the workflow, in case there are any errors in the files that should be synced.

Triggering a run for specific repos via repository dispatches

To trigger a rerun of the syncer for a list of repos, create a repository dispatch event with the following payload:

{
  "event_type": "repo_update",
  "client_payload": {
    "repos": ["exercism/julia"],
    "pusher": "helpful-user"
  }
}

Note that the repo names must be given in the full org/repo format.

Triggering a run for specific repos via workflow dispatches

To manually trigger a rerun of the syncer for a list of repos, create a workflow dispatch event.

The repos input must be given as a JSON-formatted list of repos, e.g. ["exercism/julia"].

Note that the repo names must be given in the full org/repo format.

Potential use cases

Sync files that must be present and unchanged in all tracks, e.g.

• CODE_OF_CONDUCT.md
• LICENSE.md with up-to-date year
• Must-have workflows, e.g.
  • configlet
  • markdown linting
  • label.yml syncing (ref. exercism/docs#27)

Potential future extensions

• Allow edits from maintainers for certain files or apply track-specific automated transformations instead of merely copying all files.
• Add CI check that each file in synced_files/ is part of synced_files/.github/CODEOWNERS.
• Determine which files are affected by a change/trigger event to avoid running 200 jobs each time.