Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add interactive-templates update workflow #4442

Merged
merged 3 commits into from
Jul 16, 2024

Conversation

StevenMaude
Copy link
Contributor

This is a proposal to move the interactive-templates update workflow from the interactive-templates repository to here.

The workflow was added in the interactive-templates repository to run on a new release of interactive-templates, and then open a pull request to job-server. The workflow is run daily and can be run manually on request.

This is based on the version of the workflow from opensafely-core/interactive-templates#377 which has fixes necessary for the workflow to work. The workflow operates like the "check resource for update and create a PR if so" workflows in ehrQL.

See opensafely-core/interactive-templates#118 which proposed this.

The main motivation for moving it here is to remove the need for the personal access token, which appears to have expired. With the low frequency of updates, it also seems reasonable to simplify this.

Instead of having interactive-templates create a PR when a new release
is available, check from within this repository on a regular basis.

Having this be triggered as a "pull" notification rather than a "push"
notification is not quite as refined in terms of getting updates.

However, it removes the use of a personal access token. Generally, we're
finding those unwieldy to manage as an organisation: see ebmdatalab/metrics#194.

See opensafely-core/interactive-templates#118 and
opensafely-core/interactive-templates#377 (where this workflow was
almost working in interactive-templates, except for requiring a new
personal access token).
@StevenMaude
Copy link
Contributor Author

StevenMaude commented Jul 11, 2024

Some notes:

  • it was also suggested that possibly notifying the Slack code review channel could be helpful on a release, which we could look at now or in future.
  • like lots of GitHub Actions changes, it's not easy to just try this workflow out without merging. It is very much based on existing workflows, both from the interactive-templates PR (which worked up to the point of needing the personal access token), and from ehrQL.
  • I've held off on merging the manually created Update interactive-templates to v2024.07.09.130747 #4439 so that it is potentially possible to try out the workflow on merge.
  • if this is merged, we should remove the workflow from interactive-templates and update the developer notes on what to do on a new release

Copy link
Member

@iaindillingham iaindillingham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of comments, but neither are deal-breakers.

.github/workflows/update-interactive-templates.yml Outdated Show resolved Hide resolved
Co-authored-by: Iain Dillingham <[email protected]>
@StevenMaude StevenMaude enabled auto-merge July 16, 2024 12:31
@StevenMaude StevenMaude merged commit 48887eb into main Jul 16, 2024
8 checks passed
@StevenMaude StevenMaude deleted the steve/add-interactive-templates-update-workflow branch July 16, 2024 12:34
StevenMaude added a commit to opensafely-core/interactive-templates that referenced this pull request Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants