feat: Creat waiting-to-merge action

[trillium]

Prevents merging when a waiting to merge label is applied

Fixes #1505

What changes did you make and why did you make them ?

• Prevents merging of a PR if waiting to merge label is applied
• Still needs to be tested once merged

[github-actions]

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b Spiteless-ts.1505 development
git pull https://github.com/Spiteless/VRMS.git ts.1505

[evanyang1]

Looked at it, but I need to read up more on yaml files.

[trillium]

@evanyang1 code is adapted from here. This additional action will only trigger when the conditional is met:

if: ${{ contains(github.event.*.labels.*.name, 'waiting to merge') }}

From there the workflow will fail with exit code 1, preventing the PR from being merged.

[MattPereira]

Looked at it, but I need to read up more on yaml files.

@evanyang1 The github action docs are your friend here

The on: specifies when the workflow should run. The jobs: allow you to specifiy a series of "jobs" to be executed as part of a workflow. The runs-on: specifies the container environment in the cloud where the workflow will run and the steps: specify the scripts to be executed

For this PR the environment is ubuntu and the steps run a basic bash script that logs some explanatory information and intentionally fails by exiting with a status code of 1 which is a standard error code for UNIX systems

The kicker is that just making the github aciton fail doesn't prevent a merge. You also have to add the workflow to the required checks through the settings tab of this repository which it looks like has already been done

[MattPereira]

@spiteless I took the liberty of adding the waiting to merge label for you and it looks good 👍

[MattPereira]

@spiteless did you add the workflow to the status checks for the development branch?

I've never seen a failing check not prevent a merge before

[trillium]

@MattPereira No, I haven’t taken any further steps except this new action. I expected to have some trial and error that needs to be resolved since I don't know how I'd test these locally.

[MattPereira]

@spiteless You could test on your fork by adding the appropriate branch protection rule to the fork

For the official VRMS repository someone will need access to the "Settings" tab in order to add the rule that will actually block merge when the workflow from this PR fails

[trillium]

@MattPereira Pretty sure it's working now but please double check. I just tested here:

#1498