Switch to syncing tracks via push rather than pull config

Open
#1,750 8 comments 1 reaction 2 assignees View on GitHub

Maintainers usually reply within 1 day

@SaschaMann is already working on this.

Since Dec 29, 2020.

Assessment

This issue has not been assessed yet.

Description

CI cross-track consistency discussion

GitHub recently introduced a new feature called Environments that let you create a »container« of sorts to limit access to secrets in a more fine-grained way than giving everyone with the commit bit permission to access and use them. GHA workflows can require access to an environment, which will prevent them from running until a select group of people has »reviewed« the run and clicked a button.

This feature would allow us to switch to trigger events from problem-specifications to the track repos, rather than the current configuration where track repos must pull new info.

What would (need to) change?

  • Configure a machine user with write access to all track repos.

  • Configure an environment in problem-specifications with an access token of that bot user.

  • Determine a trusted group of (currently up to 6) people who can approve workflow runs in that environment.

  • Configure a workflow in problem-specifications that sends out repository_dispatch to each track repo. repository_dispatch events are kinda like webhooks. They are web requests that may contain an arbitrary payload that are sent to the track repos and trigger a workflow run there.
    There are two viable triggers, both with their own up- and downsides:

    • push:
      • Send an event to tracks on every commit to the main branch in problem-specifications.
      • 👍 Changes to problem-specifications map 1-to-1 to repository_dispatch.
      • 👍 Changes will make their way to the track repos ASAP.
      • 👎 This may cause a lot of work for the workflow approvers, as they’ll have to approve a run for every PR.
      • 👎 It is not clear when a change will hit the track repos as it depends on the availability of the approvers.
    • schedule:
      • Once a day (or more/less often), send out an event that contains a »summary« of recent changes (if there were any) to the track repos.
      • 👍 The work for workflow approvers is limited.
      • 👍 It’s fairly predictable how long it will take for a change to trigger an event in the track repos.
      • 👎 It may take more time for a change to make its way into a track repo.
      • 👎 The receiving workflows will be more complex, as they’ll have to handle several changes at once.
  • Each track can then decide if and how they want to act on these events. For example, they could…

    • … automatically run their test generators on the new tests.
    • … open an issue that contains a summary of the change.

    Some of these could be standardized in actions, so that tracks don’t have to write their own workflows from scratch.

Advantages

  • Less resources are wasted on scheduled runs looking for changes in problem-specs.

  • We can create an event payload ourselves to make it easier for tracks to handle updates (semi-) automatically.

  • It would be easy to setup each track with a default behaviour, like creating an issue, so that even tracks that lack the peoplepower to setup elaborate automated workflows would benefit from update notifications.

  • All of this would also be possible with webhooks and an external (serverless) service where secrets are stored. However, that would require additional infrastructure and would make it harder to change or fix the setup compared to a purely GHA-based setup.

Dominant language
Ruby
Stars
362
Forks
566
Avg merge
15h 13m
Merged PRs (30d)
8

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from exercism/problem-specifications

All issues in exercism/problem-specifications

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.