Migrate AR to Github Actions #8886

ioannakok · 2023-09-21T14:50:12Z

Closes #8676

What does this change?

Adds an ar-ci.yml GitHub workflow
Replaces node-riffraff-artifact with actions-riff-raff to upload the artifacts in Riff-Raff.

Why?

We are moving away from TC

Testing

Deployed to CODE and checked various types of articles:

Standard
Liveblog
Deadblog
Gallery

Build

Deployments

Build produced by GH Actions deployed successfully

Build produced by TeamCity and GH Actions produce the same artefacts

TeamCity	GH Actions

Zip produced by TC and GH Actions has the same structure

TeamCity	GH Actions

Release plan

Add a Riff-Raff restriction to Mobile::mobile-apps-rendering
Pause TC build
Replace TC build with GH Actions built in the required checks of the repo
Remove restriction
Merge this PR and make sure Continuous Deployment gets kicked off
After making sure everything works fine raise PR to remove:

Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

Also, increase `buildNumberOffset` to 27000. Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

github-actions · 2023-09-21T15:03:50Z

Size Change: 0 B 🆕

Total Size: 0 B

_{compressed-size-action}

`apps-rendering/dist/assets/` contains `apps-rendering/dist/assets/manifest.json` and `apps-rendering/dist/assets/fonts` so no need to refer to those.

Previous structure when unzipping was mobile-apps-rendering -> dist -> server -> <files>. This was breaking deployment. After this change structure will be the expected mobile-apps-rendering -> <files> Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

ioannakok · 2023-09-22T15:00:46Z

.github/workflows/ar-ci.yml

+          yarn copy-manifest
+          yarn copy-fonts
+          yarn synth
+          zip -j dist/server/mobile-apps-rendering.zip dist/server/*


We are replacing the deprecated node-riffraff-artifact with actions-riff-raff. node-riffraff-artifact was zipping under the hood the contents of dist/server and producing mobile-apps-rendering.zip. We can verify this in its config file. We are now adding a command to do the same.

The -j option in the command stores files with the given names only. The j option doesn't store directory information. This will produce structure:

mobile-apps-rendering ├── 713.server.js ├── manifest.json ├── server.js

which is the same as what current main produces.

DanielCliftonGuardian

💎 Great work. A potential future optimisation is using actions cache https://github.com/actions/cache previously used here: https://github.com/guardian/apps-rendering/blob/ec2866f0345e8869de3e45b2de4ab11b2d3e20ec/.github/workflows/nodejs.yml#L18

georgeblahblah

Looks good, great work @ioannakok! I had two suggestions which I think would be good to apply, but not necessarily required to proceed.

georgeblahblah · 2023-09-25T09:37:06Z

.github/workflows/ar-ci.yml

+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc


Suggested change

- uses: actions/setup-node@v3

with:

node-version-file: .nvmrc

- uses: actions/setup-node@v3

with:

cache: yarn

node-version-file: .nvmrc

georgeblahblah · 2023-09-25T09:37:34Z

.github/workflows/ar-ci.yml

+
+      - name: Install dependencies
+        run: |
+          npm i -g yarn@1.x


I don't think we need this step to install yarn separately!

Suggested change

npm i -g yarn@1.x

See more: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#about-caching-workflow-dependencies Also, do not install yarn separately. Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com> Co-authored-by: DanielCliftonGuardian <110032454+DanielCliftonGuardian@users.noreply.github.com>

ioannakok · 2023-09-25T11:12:14Z

💎 Great work. A potential future optimisation is using actions cache https://github.com/actions/cache previously used here: https://github.com/guardian/apps-rendering/blob/ec2866f0345e8869de3e45b2de4ab11b2d3e20ec/.github/workflows/nodejs.yml#L18

Yes, sounds good @DanielCliftonGuardian, thanks for the recommendation! For this build I did it via the setup-node action. I will have a look to do similarly in the other workflows we did as part of this migration

ioannakok · 2023-09-25T11:39:55Z

Restriction added

ioannakok · 2023-09-25T11:41:28Z

Paused TC build

ioannakok · 2023-09-25T11:48:50Z

Replaced Apps Rendering Mono Repo (MAPI) with build which is the GH Action for the apps-rendering build. Will raise a follow-up PR to name this better

ioannakok · 2023-09-25T12:01:26Z

AR CI job was successful

https://github.com/guardian/dotcom-rendering/actions/runs/6298931426/job/17098705590

ioannakok · 2023-09-25T12:02:13Z

Continuous Deployment kicked off and was successful: https://riffraff.gutools.co.uk/deployment/view/7d988a20-a9e8-4f80-ab0c-bd2e25fbd314

ioannakok · 2023-09-25T12:04:39Z

Tried a few articles / liveblogs in apps-rendering PROD and they work fine

ioannakok · 2023-09-25T15:16:38Z

Merged PR to improve naming #8904

Migrating to GHA in #8886 has meant we are waiting on the AR status check to be successful, but it doesn't always run because of the `paths-filter`. This change removes the filter, so the action will always run.

We migrated to GHA in #8886. The repository has a status check on the AR build workflow, but the workflow doesn't always run because of the `paths-ignore`. This change removes the filter, so the action will always run and the status check will pass if the build is successful.

ioannakok and others added 3 commits September 21, 2023 16:00

Add ar-ci.sh script to run AR build in Github Actions

d0fc440

Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

Ignore dotcom-rendring path when running AR build

4693b74

Also, increase `buildNumberOffset` to 27000. Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

Fix paths in contentDirectories when uploading artifacts

5d2aad7

Co-authored-by: George B <705427+georgeblahblah@users.noreply.github.com>

ioannakok force-pushed the migrate-ar-to-github-actions branch from 12a2586 to 5d2aad7 Compare September 21, 2023 15:01

ioannakok added 2 commits September 21, 2023 16:11

Fix paths in contentDirectories

241b4b6

Upload mobile-assets once in Riff-Raff

a3a545f

`apps-rendering/dist/assets/` contains `apps-rendering/dist/assets/manifest.json` and `apps-rendering/dist/assets/fonts` so no need to refer to those.

ioannakok changed the title ~~Add ar-ci.sh script to run AR build in Github Actions~~ Migrate AR to Github Actions Sep 22, 2023

ioannakok commented Sep 22, 2023

View reviewed changes

ioannakok added the run_chromatic Runs chromatic when label is applied label Sep 22, 2023

ioannakok marked this pull request as ready for review September 22, 2023 15:56

ioannakok requested a review from a team as a code owner September 22, 2023 15:56

DanielCliftonGuardian approved these changes Sep 25, 2023

View reviewed changes

georgeblahblah approved these changes Sep 25, 2023

View reviewed changes

georgeblahblah mentioned this pull request Sep 25, 2023

feat: add front rendering app #8728

Merged

ioannakok merged commit 87a6b90 into main Sep 25, 2023
23 checks passed

ioannakok deleted the migrate-ar-to-github-actions branch September 25, 2023 11:50

georgeblahblah mentioned this pull request Sep 27, 2023

Always run the AR build #8925

Merged

ioannakok mentioned this pull request Nov 28, 2023

Remove Teamcity traces #9668

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate AR to Github Actions #8886

Migrate AR to Github Actions #8886

ioannakok commented Sep 21, 2023 •

edited

Loading

github-actions bot commented Sep 21, 2023 •

edited

Loading

ioannakok Sep 22, 2023

DanielCliftonGuardian left a comment

georgeblahblah left a comment

georgeblahblah Sep 25, 2023

georgeblahblah Sep 25, 2023

ioannakok commented Sep 25, 2023 •

edited

Loading

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023 •

edited

Loading

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

Migrate AR to Github Actions #8886

Migrate AR to Github Actions #8886

Conversation

ioannakok commented Sep 21, 2023 • edited Loading

What does this change?

Why?

Testing

Build

Deployments

Release plan

github-actions bot commented Sep 21, 2023 • edited Loading

ioannakok Sep 22, 2023

Choose a reason for hiding this comment

DanielCliftonGuardian left a comment

Choose a reason for hiding this comment

georgeblahblah left a comment

Choose a reason for hiding this comment

georgeblahblah Sep 25, 2023

Choose a reason for hiding this comment

georgeblahblah Sep 25, 2023

Choose a reason for hiding this comment

ioannakok commented Sep 25, 2023 • edited Loading

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023 • edited Loading

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 25, 2023

ioannakok commented Sep 21, 2023 •

edited

Loading

github-actions bot commented Sep 21, 2023 •

edited

Loading

ioannakok commented Sep 25, 2023 •

edited

Loading

ioannakok commented Sep 25, 2023 •

edited

Loading