labeler action is misconfigured
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with .github/workflows/labeler-pr.yml and .github/labeler.yml, then compare the documented actions/labeler versions and prior configuration attempts. Decide whether Design should describe affected documentation paths or introduced design content; done means the chosen policy is configured, the version is intentional, and representative pull requests receive the expected label.
Written by the indexing model from the issue text.
Description
This is an issue instead of a PR because I don't know what the intended "correct" is, so treat it as a choose your own adventure PR.
The labeler action is currently not configured to match proposals in departments/cargo (using the old cargo-salvage name instead).
Additionally, there's an inconsistency with the main repo: this repo is currently using actions/labeler v4. Main repo is using v5.
Latest is v6 (which doesn't seem to introduce significant changes?). Regardless, available versions are in the action repo's tags, with changelogs in the releases.
Past configuration attempts, but correct
Based on @VasilisThePikachu's attempts from https://github.com/space-wizards/docs/commits/master/.github/labeler.yml)
For labeler v4
"Design":
- 'src/en/general-proposals/**'
- 'src/en/space-station-14/*/proposals/**'
- 'src/en/space-station-14/departments/*/proposals/**'
or more generic
"Design":
- 'src/en/general-proposals/**'
- 'src/en/**/proposals/**'
For labeler v5
"Design":
- changed-files:
- any-glob-to-any-file:
- 'src/en/general-proposals/**'
- 'src/en/space-station-14/*/proposals/**'
- 'src/en/space-station-14/departments/*/proposals/**'
or more generic
"Design":
- changed-files:
- any-glob-to-any-file:
- 'src/en/general-proposals/**'
- 'src/en/**/proposals/**'
More broad
Arguably, all changes to src/en/space-station-14/** are design changes. Going back, some PRs which should be tagged Design... weren't. As such:
For labeler v4
"Design":
- 'src/en/general-proposals/**'
- 'src/en/space-station-14/**'
For labeler v5
"Design":
- changed-files:
- any-glob-to-any-file:
- 'src/en/general-proposals/**'
- 'src/en/space-station-14/**'
Give up
Arguably-er, blindly tagging all commits which touch a design document with the Design tag is silly. Fixing a typo doesn't mean someone is codifying the game's design.
This begs the question: is the tag supposed to indicate which part of the docs are affected, or what the PR is intended to introduce? If it's the latter, maybe the Design tag just shouldn't be automatically added.
This PR brought to you by: sleepy rambling
- Dominant language
- CSS
- Stars
- 42
- Forks
- 304
- PR merge metrics
- No merged PRs in 30d
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from space-wizards/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
space-wizards/docs#651 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
space-wizards/docs#364 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
space-wizards/docs#677 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
space-wizards/docs#666 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
space-wizards/docs#663 ·
All issues in space-wizards/docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zerocracy/judges-action#2733 ·
Maintainers usually reply within 8 days
-
dependencies feature github_actions good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
wemake-services/wemake-django-template#3149 ·
Maintainers usually reply within 1 day
-
CI/CD
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
GiganticMinecraft/seichi-portal-frontend#1185 ·
Maintainers usually reply within 1 day
-
severity: low
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
luainkernel/lunatik#1848 ·
Maintainers usually reply within 1 day
-
enhancement help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
zmo2s/agent-toolbox#22 ·