ci: :construction_worker: improve GitHub Actions workflows

[ap0nia]

Summary

Features

• All workflow files have a yaml-language-server schema comment at the top of the file to specify the schema for the YAML LSP, which is helpful for developers that use code editors that rely on LSPs for code analysis (i.e. VSCode, NeoVim, not JetBrains)
• All jobs and steps have a name, which can provide more insight into what it does (or sometimes the job name is the same as the workflow name because there's nothing else to describe lol, but it's there anyways for consistency)
• all related deployment processes are consolidated into a single workflow
  • deploy-staging.yml - deploys staging environments for the API and documentation during a pull request
  • deploy-prod.yml - deploys production environments for the API and documentation
  • destroy-staging.yml - destroys the staging environments for the API and documentation after a pull request is closed

Notes

The workflow files can't be renamed immediately, otherwise they won't be triggered since they don't exist on the main branch. Maybe open another PR with no-deploy to change the names afterward? Or push directly to main if you have admin permissions. skill issue; I swear I've been harassed by this random issue before lol

[ecxyzzy]

The workflow files can't be renamed immediately, otherwise they won't be triggered since they don't exist on the main branch. Maybe open another PR with no-deploy to change the names afterward? Or push directly to main if you have admin permissions.

Wait actually? I remember renaming conventional-pr.yml to lint-pr.yml for #69 and it ran fine on the PR.

[ecxyzzy]

Also is there a reason the lint-and-format-pr action didn't re-fire on PR name change? I tried rerunning it manually, but it seems to be using the old PR title for some reason.

[ap0nia]

I feel like that could've been the conventional-pr.yml running from the main branch; not the one running from the feature branch. i.e. It was running the old workflow that just did a conventional-commit check, instead of the linting + formatting/updating the PR title.

There's an open issue and the general consensus is to create a workflow file that exists on the main branch before testing it on development branches https://github.com/orgs/community/discussions/25746

I don't really get all these workflow shenanigans lol

[ecxyzzy]

Nope, it definitely ran the new workflow: https://github.com/icssc/peterportal-api-next/actions/runs/5859266473/job/15884907857 I think it should be fine if you rename the workflows on this branch.

[ap0nia]

Ok, let me try

[ap0nia]

Also is there a reason the lint-and-format-pr action didn't re-fire on PR name change? I tried rerunning it manually, but it seems to be using the old PR title for some reason.

Ok, so by default "runs on pull_request" means "opened, synchronize, or reopened" ; I added "edited" too

hm, it seems a caveat is that editing the PR body also causes the action to run; i.e. editing the PR title or body will cause it to check whether to update the title