Staging and production deployment workflows #563

rbadillap · 2021-12-27T19:55:22Z

Description

This Pull Requests separates the workflow that deploys to staging should take comparing with production.
In the case of STAGING we want the deployment to be executed when a pull request is merged to the main branch, or when there is a direct commit to that branch.
The tags that must be applied for that environment are those related to the last commit (short sha) and also the tag: latest.

For PRODUCTION, the tag latest shouldn't be applied, instead of that, the word stable is the one to be applied.

Testing Instructions

Merge a Pull Request into main branch (deploy to STAGING)
Create a new release (deploy to PRODUCTION)

Checklist

My pull request has a descriptive title (not a vague title like Update index.md).
My pull request targets the default branch of the repository (main) or a parent feature branch.
My commit messages follow best practices.
My code follows the established code style of the repository.
I added or updated tests for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

obulat · 2021-12-28T03:54:16Z

I am not sure I can really comment on this PR due to my lack of knowledge in this area, but I love the automation!

We have only one staging env, right? It could probably be nice if it was possible to also stage the feature branches (audio integration, redesign) before merging them into main.

zackkrida · 2022-01-03T18:21:12Z

I like how you've separated the work here, it makes sense to me. I think if we ever needed more environments we'd just refactor how this works completely and perhaps not even use GitHub actions.

zackkrida · 2022-01-03T18:21:24Z

Feel free to undraft this so you can test it!

AetherUnbound

A few thoughts/questions!

AetherUnbound · 2022-01-11T15:52:52Z

.github/workflows/build.yml

+
+      # for production
+      # gather metadata from git & github actions to reference in docker
+      - name: git & github metadata production


There are a lot of similarities between this and the staging step. I wonder if we might be able to combine the logic and add conditions in certain places for each deployment case.

That's a good point, and that's what I mentioned when I officially announced this PR.

This is something that will be improved in the future based on what we are going to see when deploying this on the real infrastructure.

By now, I'm separating the logic between staging and production, but I'm planning to send a PR to the official action project (owned by Docker) that allows me to manipulate the tags without the need to duplicate the whole step.

cc @zackkrida

.github/workflows/push_production.yaml

AetherUnbound · 2022-01-11T15:55:20Z

.github/workflows/build.yml

+          context: .
+          tags: ${{ steps.metadata_production.outputs.tags }}
+          labels: ${{ steps.metadata_production.outputs.labels }}
+          push: true


Does this push trigger a deployment of our AWS infrastructure? Is that encapsulated in this workflow or will that be future work?

The deployment is made by CodePipeline in our AWS. I just push the image to ECR and the event will automatically be triggered internally.

That's why I opened a discussion a few days ago, because I would need to change this part and build some communication between CodePipeline and ghcr.io events.

.github/workflows/push_production.yaml

* main: (73 commits) Make audio/image pages without ids show a 404 (#768) Fix logo button paddings and simplify implementation (#767) Fix global audio rtl close placement (#780) Check for `null` localStorage explicitly (#763) Truncate global audio text to two lines (#773) New image details page (#682) Switch to path-based i18n routing (#701) Enable source maps in production (#755) Remove Jamendo and Wikimedia Commons from audio meta sources (#747) Use jed1x json format to correctly handle pluralization (#753) Fix logo color on error page layout (#752) Add homepage content switcher for mobile screens (#716) Add inline-start border to filters on desktop (#748) Fix header items not fitting in (#718) Expose `close` to popover content via slot props (#736) Truncate row layout audio titles (#735) Stop blocking on analytics requests (#715) Style links globally (#727) Refactor the usage of i18n result count computation (#707) Use `VPopover` for the content report form (#719) ...

…purposes

zackkrida

Seeing an issue, it appears the run failed with an error: https://github.com/WordPress/openverse-frontend/actions/runs/1785344194

Can't find 'action.yml', 'action.yaml' or 'Dockerfile' under '/home/runner/work/openverse-frontend/openverse-frontend/.github/workflows/build.yaml@v1'. Did you forget to run actions/checkout before running your local action?

… production environment

rbadillap · 2022-02-03T01:36:48Z

The pipeline has been fixed and you can consider it ready for review.

rbadillap · 2022-02-03T01:39:25Z

The build workflow was moved as an action, in order to be called by other workflows in the following way:

- name: docker build
  uses: ./.github/actions/build

.github/workflows/pre-build.yaml

.github/workflows/push_staging.yaml

zackkrida

Looks good, I left a few suggestions!

AetherUnbound

Looks good!

feat: added deploy workflows for staging and production

a4c6fef

obulat added 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🤖 aspect: dx Concerns developers' experience with the codebase labels Dec 28, 2021

zackkrida changed the title ~~feat: added deploy workflows for staging and production environments~~ Staging and production deployment workflows Jan 5, 2022

merge conflicts before undraft the PR

47cca89

rbadillap marked this pull request as ready for review January 11, 2022 15:40

rbadillap requested a review from a team as a code owner January 11, 2022 15:40

rbadillap requested review from zackkrida and dhruvkb January 11, 2022 15:40

AetherUnbound reviewed Jan 11, 2022

View reviewed changes

feat: rename the event that triggers the deploy to production

a833c36

zackkrida approved these changes Jan 17, 2022

View reviewed changes

.github/workflows/push_production.yaml Outdated Show resolved Hide resolved

.github/workflows/push_production.yaml Outdated Show resolved Hide resolved

zackkrida self-requested a review January 17, 2022 18:23

zackkrida and others added 5 commits February 1, 2022 17:41

format files

a6ac112

feat: switch prerelease event to release

ad503dd

feat: change the url of the deployment workflow for visual reference …

f6f8763

…purposes

test: deploying to staging and production environments

4056491

rbadillap had a problem deploying to staging February 2, 2022 17:41 Failure

zackkrida approved these changes Feb 2, 2022

View reviewed changes

zackkrida self-requested a review February 2, 2022 18:08

test: point the branch in the action name to avoid errors

5b83ee4

rbadillap had a problem deploying to staging February 2, 2022 22:53 Failure

fix: point the right name of the build workflow file

6a8d006

feat: fix the inputs and env vars in the action file

d2b4e03

rbadillap had a problem deploying to staging February 3, 2022 00:25 Failure

Update action.yml

2fb595e

rbadillap had a problem deploying to staging February 3, 2022 00:30 Failure

Update action.yml

5db5964

rbadillap had a problem deploying to staging February 3, 2022 00:35 Failure

Update action.yml

8d3a737

rbadillap had a problem deploying to staging February 3, 2022 00:51 Failure

Update action.yml

af9cb5c

rbadillap temporarily deployed to staging February 3, 2022 00:58 Inactive

Update action.yml

bcce151

rbadillap temporarily deployed to staging February 3, 2022 01:06 Inactive

Update action.yml

5eb2272

rbadillap temporarily deployed to staging February 3, 2022 01:09 Inactive

Update action.yml

2b78775

rbadillap temporarily deployed to staging February 3, 2022 01:12 Inactive

feat: stabilize the workflows and propagate the same configuration to…

acc8fc2

… production environment

rbadillap temporarily deployed to staging February 3, 2022 01:35 Inactive

rbadillap requested review from AetherUnbound and sarayourfriend February 3, 2022 01:37

zackkrida reviewed Feb 3, 2022

View reviewed changes

.github/workflows/pre-build.yaml Show resolved Hide resolved

zackkrida reviewed Feb 3, 2022

View reviewed changes

.github/workflows/push_staging.yaml Show resolved Hide resolved

zackkrida approved these changes Feb 3, 2022

View reviewed changes

AetherUnbound approved these changes Feb 3, 2022

View reviewed changes

rbadillap merged commit a3d9eb8 into main Feb 3, 2022

rbadillap deleted the ci/actions branch February 3, 2022 20:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Staging and production deployment workflows #563

Staging and production deployment workflows #563

rbadillap commented Dec 27, 2021

obulat commented Dec 28, 2021

zackkrida commented Jan 3, 2022

zackkrida commented Jan 3, 2022

AetherUnbound left a comment

AetherUnbound Jan 11, 2022

rbadillap Jan 11, 2022

AetherUnbound Jan 11, 2022

rbadillap Jan 11, 2022

zackkrida left a comment •

edited

Loading

rbadillap commented Feb 3, 2022

rbadillap commented Feb 3, 2022

zackkrida left a comment

AetherUnbound left a comment

Staging and production deployment workflows #563

Staging and production deployment workflows #563

Conversation

rbadillap commented Dec 27, 2021

Description

Testing Instructions

Checklist

Developer Certificate of Origin

obulat commented Dec 28, 2021

zackkrida commented Jan 3, 2022

zackkrida commented Jan 3, 2022

AetherUnbound left a comment

Choose a reason for hiding this comment

AetherUnbound Jan 11, 2022

Choose a reason for hiding this comment

rbadillap Jan 11, 2022

Choose a reason for hiding this comment

AetherUnbound Jan 11, 2022

Choose a reason for hiding this comment

rbadillap Jan 11, 2022

Choose a reason for hiding this comment

zackkrida left a comment • edited Loading

Choose a reason for hiding this comment

rbadillap commented Feb 3, 2022

rbadillap commented Feb 3, 2022

zackkrida left a comment

Choose a reason for hiding this comment

AetherUnbound left a comment

Choose a reason for hiding this comment

zackkrida left a comment •

edited

Loading