Skip to content

Commit

Permalink
gh-pages build: ci: improve and automate issue/PR labels (#72)
Browse files Browse the repository at this point in the history
(_edited on 03-01-2024_)

With cactbot's transition to a community-maintained project, I'd like to
propose some changes to the issue/PR labels to help with organization
and automation. This PR includes _~a handful of workflow scripts~ an
update to the existing PR labeling workflow script_ to automate some of
the label management discussed below.

I'm admittedly trying to strike a balance between adding things that
will be useful and will keep the issue/PR lists scrubbed (especially
if/when repo activity ramps up leading in to 7.0), but not
overengineering. I'm not sure how well this proposal strikes that
balance, so this is definitely a wide call for comments, suggestions,
and pushback.

NB: If we decide to go forward with this (or some version of this)
proposal, it probably makes sense to throw this in a 'maintainers' guide
doc or something similar. But I'd be inclined to tackle that with a
follow-up PR.

## Issue Labels:
Existing issue type labels (`bug`, `question`, `enhancement`) are
automatically applied when a new issue is opened. `needs-review` is also
automatically applied to all new issues (and can be manually removed
once an issue is reviewed).

I propose to keep that behavior, and add the following label options:

| Label | Applied | Intent |
|:------|:--------|:-------|
| `pending info` | Manual | Used when we are waiting on more info from
the issue opener. |
| `cant repro` | Manual | Used when a bug cannot be reproduced and
appears unique to the issue opener. |
| `fix-me` | Manual & Automatic | Used to indicate a valid bug/feature
request that should be addressed. (Auto-applied when issue linked to
PR.) |
| `not planned` | Manual | Used to indicate that a bug/requested feature
is intended behavior, a system limitation, etc., and won't be addressed.
|
| _~`stale`~_ | _~Automatic~_ | _~Applied automatically to inactive
issues (see discussion below) after a period of inactivity. If there is
no further activity, they will be automatically closed.~_ |

## PR Labels:
Similarly to issues, I propose to automatically label PRs with
`needs-review` when opened and whenever a new commit is pushed to the PR
_(until an approving review is submitted)_. That label ~can be manually
removed by the reviewer once the PR has been initially reviewed~ _will
be automatically removed whenever a maintainer submits a review
(approving or otherwise)_.

I also propose to add the following label option~s~:

| Label | Applied | Intent |
|:------|:--------|:-------|
| `auto-merge` | Automatic | Toggled whenever a PR's auto-merge setting
is changed (added visibility for reviewers before approving). |
| _~`changes-requested`~_ | _~Manual~_ | _~Used when a reviewer has
requested changes before merging. Can be manually removed once changes
are committed & reviewed.~_ |
| _~`review-complete`~_ | _~Automatic~_ | _~Automatically applied when
an approving review is submitted.~_ |
| _~`stale`~_ | _~Automatic~_ | _~Same as with issues (see discussion
below).~_ |

## Supporting Workflow Scripts:
This PR modifies the existing (now renamed) `labels.yaml` ->
`label_pr.yml` script to automate this functionality, specifically:
* If a PR is opened or a new commit is pushed:
  * auto-label.cjs will (continue to) add scope-related labels
* auto_label.cjs will add `needs-review` unless the PR already has an
approving review from a maintainer
  * Any linked issues will have the `fix-me` label applied to them.
* If a review (approving or otherwise) is added by a maintainer, the
`needs-review` label is removed.
* If auto merge is enabled or disabled on the PR, the `auto-merge` label
is added/removed.

_~This PR includes some workflow scripts to help automate the label
management discussed above.~_

* _~`label-linked-issues` - adds `fix-me` to an issue when it is linked
to a PR.~_
* _~`label-pr-automerge` - toggles `auto-merge` on a PR whenever the
auto-merge setting is changed.~_
* _~`label-pr-review` -~_
* _~Adds `review-complete` (and removes `needs-review`) when an
approving review is submitted.~_
* _~Adds `needs-review` to a PR when opened or when a new commit is
pushed (**unless** `review-complete` is present).~_
* _~`stale-daemon` - runs `actions/stale` every 4 hours and:~_
* _~Adds `stale` to any issue that has had no activity in 30 days and
__does not have__ `needs-review` or `fix-me`.~_
* _~Adds `stale` to any PR that has had no activity in 60 days and
__does not have__ `needs-review`.~_
* _~Removes `stale` from any issue/PR if there is subsequent activity.~_
* _~Closes any issue/PR that has been labeled `stale` for 7 days with no
subsequent activity.~_
* _~Adds an explanatory comment to issues/PRs when marking as `stale` or
closing.~_ b177af5
  • Loading branch information
github-actions committed Mar 3, 2024
0 parents commit eb77fa4
Show file tree
Hide file tree
Showing 216 changed files with 521,455 additions and 0 deletions.
6 changes: 6 additions & 0 deletions resources/ffxiv/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Files in this folder are art reused from Final Fantasy XIV.

FINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd.

Final Fantasy art and icons reused non-commercially under the
[FINAL FANTASY® XIV Materials Usage License](https://support.na.square-enix.com/rule.php?id=5382).
Binary file added resources/ffxiv/jobs/acn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/alc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/arc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/arm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/ast-framed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/ast-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/ast.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blm-framed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blm-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blu-framed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blu-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/blu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/bot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/brd-framed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/brd-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/brd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/bsm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/cho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/cnj.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/crp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/cul.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/dnc-framed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/dnc-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/dnc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/ffxiv/jobs/drg-framed.png
Binary file added resources/ffxiv/jobs/drg-large.png
Binary file added resources/ffxiv/jobs/drg.png
Binary file added resources/ffxiv/jobs/drk-framed.png
Binary file added resources/ffxiv/jobs/drk-large.png
Binary file added resources/ffxiv/jobs/drk.png
Binary file added resources/ffxiv/jobs/fsh.png
Binary file added resources/ffxiv/jobs/gla.png
Binary file added resources/ffxiv/jobs/gnb-framed.png
Binary file added resources/ffxiv/jobs/gnb-large.png
Binary file added resources/ffxiv/jobs/gnb.png
Binary file added resources/ffxiv/jobs/gsm.png
Binary file added resources/ffxiv/jobs/limit break.png
Binary file added resources/ffxiv/jobs/lnc.png
Binary file added resources/ffxiv/jobs/ltw.png
Binary file added resources/ffxiv/jobs/mch-framed.png
Binary file added resources/ffxiv/jobs/mch-large.png
Binary file added resources/ffxiv/jobs/mch.png
Binary file added resources/ffxiv/jobs/min.png
Binary file added resources/ffxiv/jobs/mnk-framed.png
Binary file added resources/ffxiv/jobs/mnk-large.png
Binary file added resources/ffxiv/jobs/mnk.png
Binary file added resources/ffxiv/jobs/mrd.png
Binary file added resources/ffxiv/jobs/nin-framed.png
Binary file added resources/ffxiv/jobs/nin-large.png
Binary file added resources/ffxiv/jobs/nin.png
Binary file added resources/ffxiv/jobs/pet.png
Binary file added resources/ffxiv/jobs/pgl.png
Binary file added resources/ffxiv/jobs/pld-framed.png
Binary file added resources/ffxiv/jobs/pld-large.png
Binary file added resources/ffxiv/jobs/pld.png
Binary file added resources/ffxiv/jobs/rdm-framed.png
Binary file added resources/ffxiv/jobs/rdm-large.png
Binary file added resources/ffxiv/jobs/rdm.png
Binary file added resources/ffxiv/jobs/rog.png
Binary file added resources/ffxiv/jobs/rpr-framed.png
Binary file added resources/ffxiv/jobs/rpr-large.png
Binary file added resources/ffxiv/jobs/rpr.png
Binary file added resources/ffxiv/jobs/sam-framed.png
Binary file added resources/ffxiv/jobs/sam-large.png
Binary file added resources/ffxiv/jobs/sam.png
Binary file added resources/ffxiv/jobs/sch-framed.png
Binary file added resources/ffxiv/jobs/sch-large.png
Binary file added resources/ffxiv/jobs/sch.png
Binary file added resources/ffxiv/jobs/sge-framed.png
Binary file added resources/ffxiv/jobs/sge-large.png
Binary file added resources/ffxiv/jobs/sge.png
Binary file added resources/ffxiv/jobs/smn-framed.png
Binary file added resources/ffxiv/jobs/smn-large.png
Binary file added resources/ffxiv/jobs/smn.png
Binary file added resources/ffxiv/jobs/thm.png
Binary file added resources/ffxiv/jobs/war-framed.png
Binary file added resources/ffxiv/jobs/war-large.png
Binary file added resources/ffxiv/jobs/war.png
Binary file added resources/ffxiv/jobs/whm-framed.png
Binary file added resources/ffxiv/jobs/whm-large.png
Binary file added resources/ffxiv/jobs/whm.png
Binary file added resources/ffxiv/jobs/wvr.png
Binary file added resources/ffxiv/status/arcane-circle.png
Binary file added resources/ffxiv/status/arrow.png
Binary file added resources/ffxiv/status/astral.png
Binary file added resources/ffxiv/status/balance.png
Binary file added resources/ffxiv/status/battle-litany.png
Binary file added resources/ffxiv/status/battlevoice.png
Binary file added resources/ffxiv/status/bole.png
Binary file added resources/ffxiv/status/brotherhood.png
Binary file added resources/ffxiv/status/chain-stratagem.png
Binary file added resources/ffxiv/status/contagion.png
Binary file added resources/ffxiv/status/devilment.png
Binary file added resources/ffxiv/status/devotion.png
Binary file added resources/ffxiv/status/divination.png
Binary file added resources/ffxiv/status/dragon-sight.png
Binary file added resources/ffxiv/status/earth.png
Binary file added resources/ffxiv/status/embolden.png
Binary file added resources/ffxiv/status/ewer.png
Binary file added resources/ffxiv/status/fire.png
Binary file added resources/ffxiv/status/foes-requiem.png
Binary file added resources/ffxiv/status/food.png
Binary file added resources/ffxiv/status/hypercharge.png
Binary file added resources/ffxiv/status/ice.png
Binary file added resources/ffxiv/status/lady-of-crowns.png
Binary file added resources/ffxiv/status/lightning.png
Binary file added resources/ffxiv/status/lord-of-crowns.png
Binary file added resources/ffxiv/status/mug.png
Binary file added resources/ffxiv/status/offguard.png
Binary file added resources/ffxiv/status/peculiar-light.png
Binary file added resources/ffxiv/status/physical.png
Binary file added resources/ffxiv/status/potion.png
Binary file added resources/ffxiv/status/radiant-finale.png
Binary file added resources/ffxiv/status/searing-light-6.0.png
Binary file added resources/ffxiv/status/searing-light.png
Binary file added resources/ffxiv/status/spear.png
Binary file added resources/ffxiv/status/spire.png
Binary file added resources/ffxiv/status/standard-finish.png
Binary file added resources/ffxiv/status/technical-finish.png
Binary file added resources/ffxiv/status/trick-attack.png
Binary file added resources/ffxiv/status/umbral.png
Binary file added resources/ffxiv/status/water.png
Binary file added resources/ffxiv/status/wind.png
Binary file not shown.
Binary file added resources/sounds/BigWigs/Alarm.webm
Binary file not shown.
Binary file added resources/sounds/BigWigs/Alert.webm
Binary file not shown.
Binary file added resources/sounds/BigWigs/Info.webm
Binary file not shown.
Binary file added resources/sounds/BigWigs/Long.webm
Binary file not shown.
6 changes: 6 additions & 0 deletions resources/sounds/BigWigs/license.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
We acquired them from the BigWigs World of Warcraft addon
project, and were told these were contributed from an unknown
source. We believe these sounds come from freesound.org,
which would make them licensed under the Creative Commons
License.

Binary file not shown.
Binary file added resources/sounds/Overwatch/D.Va_-_Game_on.webm
Binary file not shown.
Binary file added resources/sounds/Overwatch/Hanzo_-_Sake.webm
Binary file not shown.
6 changes: 6 additions & 0 deletions resources/sounds/Overwatch/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Files in this directory come from: https://overwatch.gamepedia.com and are used
without modification.

They are distributed under the Attribution-NonCommercial-ShareAlike 3.0
Unported (CC BY-NC-SA 3.0) license. Full license text can be found at
https://creativecommons.org/licenses/by-nc-sa/3.0/
Binary file not shown.
29 changes: 29 additions & 0 deletions resources/sounds/freesound/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
These sounds from freesound.org and licensed via Creative Commons licenses.
The details of each license along with source for each sound is listed below.
All sounds have been converted from .wav to .webm for space.

alarm.webm
https://freesound.org/people/ZyryTSounds/sounds/219244/
http://creativecommons.org/publicdomain/zero/1.0/
modifications: shortened to first second

amy/
http://www.freesound.org/people/Timbre/sounds/83033/
https://creativecommons.org/licenses/by-nc/3.0/
modifications: sound cut into separate files

percussion_hit.webm
https://freesound.org/people/Stumber/sounds/207863/
https://creativecommons.org/publicdomain/zero/1.0/

power_up.webm
https://freesound.org/people/GameAudio/sounds/220173/
https://creativecommons.org/publicdomain/zero/1.0/

sonar.webm
https://freesound.org/people/NoiseCollector/sounds/6164/
https://creativecommons.org/licenses/by/3.0/

water_drop.webm
https://freesound.org/people/paespedro/sounds/174718/
https://creativecommons.org/publicdomain/zero/1.0/
Binary file added resources/sounds/freesound/alarm.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/1.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/10.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/2.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/3.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/4.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/5.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/6.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/7.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/8.webm
Binary file not shown.
Binary file added resources/sounds/freesound/amy/9.webm
Binary file not shown.
Binary file added resources/sounds/freesound/percussion_hit.webm
Binary file not shown.
Binary file added resources/sounds/freesound/power_up.webm
Binary file not shown.
Binary file added resources/sounds/freesound/sonar.webm
Binary file not shown.
Binary file added resources/sounds/freesound/water_drop.webm
Binary file not shown.
Loading

0 comments on commit eb77fa4

Please sign in to comment.