disable workflows for forks of this project #1049
Description
Observation:
I create a fork of this project/repo... it works well.
After some hours i get a error mail, because some github workflows are automatically running (and i do not have the necessary resources or permissions in place). This can irritate users, because most of them, i assume just want to fork the repo to play with the content and not build the tutorial site. As we have 60k forks i think we should have a strategy about this issue.
Suggestion:
as most users are only readers of the fork or playing around with the tutorial itself, i would recommend that we only run github workflows on the main project (by default). There are two (or more) ways to implement this.
Option1:
- Add “only run in the original repo” guard (the best project-side fix)
- we add a conditional at the top of every risky workflow: (or some kind of configuration value, this may even be better)
if: github.repository == 'ORIGINAL_OWNER/ORIGINAL_REPO' - then only in the original repo, workflows are running automatically
- we add a hint to the contribute section, that developers who want to contribute should activate workflows explicitely
Option2:
- we add a hint to the documentation, that people creating forks have to deactivate workflows in their copy of the fork.
- Disable workflows entirely in your fork (recommended)
Go to: Settings → Actions → General → Actions Permissions
Set to: ✔ Disable Actions
OR ✔ Allow Actions but do not run them on fork events
This is the simplest and avoids noise.
and this is the way i have done it for now (for myself)
However i think, Option 1 would be better. (it is off by default).