Refactor GHA workflows

[dskvr]

Lint

• Removed Redoc build and deploy from lint

Deploy

• Moved all env to global scope instead of job scope (DRY)
• Created workflow that triggers on PR merge (common case) and production branch push (edge case, in the case of a force push for example)
• Deploys packages to GHP registry.
• Builds and deploys docs.

Notes

• Created separate jobs for deploy, this is so that GH Pages deploy and Packages Deploy can occur in parallel. Not worth it
• Might be better if lint were ran without building docker since it is only code formatting. The benefit to running it this way however, would be that it also confirms lint functionality via docker and aligns with user reproducibility principle @ktamas77

Todo

• Carry artifacts between jobs in deploy Decided against separate jobs

[dskvr]

On second thought, will not do separate jobs, because too much leg work would be required to carry the artifacts between jobs since we rely heavily on docker compose (only hacks can be used with docker save and compose, not worth it)

[ktamas77]

Looks great, thank you for separating the jobs!
Feel free to go ahead & bring it out of draft status so we can verify both jobs passing correctly.
As a next step, I'd recommend to extend the flow in the following way (i'm going to take care of this after this one merged)

Job tree:

1. Pull containers from registry (cache)
   -> Change? Build change layers & upload containers to registry
2. -> Run Parallel jobs (all pulling from container registry as base):
   - Linter
   - Style check
   - API Doc Gen
   - Unit Tests

[ktamas77]

On second thought, will not do separate jobs, because too much leg work would be required to carry the artifacts between jobs since we rely heavily on docker compose (only hacks can be used with docker save and compose, not worth it)

in this case, i'll go ahead and implement the tree above which could be the foundation to effectively parallelize the jobs with minimum redundancy.

[dskvr]

@ktamas77 Out of draft status. We will likely need to override the Check Requirement since the workflow filename changed or add the old check into this branch to trick the Check Requirement into passing. I believe this check is hanging because GH is presently requiring a check that does not exist in this branch.

[ktamas77]

[low-prio non-blocking nit-pick]

Suggested change

	run: docker compose run api yarn lint-prettier
	run: docker compose run api yarn lint-prettier

[ktamas77]

Nice!