Scaffold multi-package workspace. #6850

anthonyshew · 2024-06-19T17:09:46Z

Description

Create the structure for a multi-package workspace for the Node.js website.

Core maintainers have expressed a desire for re-using code from the website in other places. These changes allows for those publishable packages to be created, since they can now be broken out to their own separate packages.

Unfortunately, this involves a large-scale cutover from the repository's previous structure, invalidating PR's that come from current main. I've received maintainer approval for my disruptiveness. 🙏

Fortunately, those outstanding PRs can be fairly easily re-aligned with this PR, since I've made near-zero changes as far as the source code is concerned. This PR updates tooling, rather than functional code. (Prettier updated ~10 files that I saw at one point, but I don't believe this came from the changes I've made. I think the source code was somehow out-of-sync with the Prettier configuration.) If you'd like your PR to meet back up with this one, you should be able to move them from their current location to ./apps/site/<your-path>.

Validation

One thing I can say I certainly don't know about in this repo is crowdin.yml. I'm not familiar with that tool so I don't know if it makes sense to move into the apps/site directory or if it needs to stay in the root.
I've tried to find breakages and configuration differences from main to here and have satisfied my initial attempts to break myself.
We can name the directory for the site something other than site, as desired. Just let me know!
I'll need some help making sure that CI has been re-aligned properly, both in GHA and in Vercel (cc @ovflowd in particular for Vercel, I believe).

Anthony's Checklist

vercel · 2024-06-19T17:09:50Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nodejs-org	❌ Failed (Inspect)		Jul 3, 2024 9:13pm

anthonyshew · 2024-06-23T22:06:55Z

.github/workflows/lint-and-tests.yml

        # See https://turbo.build/repo/docs/reference/command-line-reference/run#--force
-        run: echo "turbo_args=--force=true --cache-dir=.turbo/cache" >> "$GITHUB_OUTPUT"


This is no longer needed as of Turborepo 2, since it's the default.

bmuenzenmeyer · 2024-06-24T04:27:21Z

I looked into crowdin renames - this was the best I could find so far.

https://community.crowdin.com/t/change-source-file-name-without-loosing-progress/7594/3

I will ask in our Slack channel with Crowdin to confirm or supply something more detailed

Andrulko · 2024-06-24T15:05:14Z

One thing I can say I certainly don't know about in this repo is crowdin.yml. I'm not familiar with that tool so I don't know if it makes sense to move into the apps/site directory or if it needs to stay in the root.

Please keep this file in the root of the branch, it is used by Crowdin <-> GitHub connector:
https://support.crowdin.com/github-integration/

It would be required to update paths to EN files to be able to sync sources and translations:
https://github.com/nodejs/nodejs.org/blob/main/crowdin.yml

Please pause Crowdin <-> GitHub sync before merging the PR, then after it's merged Crowdin team will help to adapt the existing Crowdin project and configuration file to the new structure.

anthonyshew · 2024-06-24T19:16:51Z

Thanks, @Andrulko! I've remapped those paths now, if you'd like to check them to confirm I've done so correctly.

Andrulko · 2024-06-25T06:48:51Z

@anthonyshew Just to make sure that everything would work fine, let's insert / at the beginning of path. Please use the configuration below:

commit_message: 'chore: synced translations from crowdin [skip ci]'
append_commit_message: false
pull_request_title: '[automated]: crowdin sync'
pull_request_labels:
  - 'github_actions:pull-request'
files:
  - source: /apps/site/pages/en/**/*.md
    translation: /apps/site/pages/%two_letters_code%/**/%original_file_name%
    content_segmentation: 0
    ignore:
      - /apps/site/pages/en/blog/**/*.md
      - /apps/site/pages/en/learn/**/*.md
      - /apps/site/pages/en/download/index.md
      - /apps/site/pages/en/download/current.md
    languages_mapping:
      two_letters_code:
        es-ES: es
        pt-BR: pt-br
        zh-CN: zh-cn
        zh-TW: zh-tw
  - source: /apps/site/pages/en/**/*.mdx
    translation: /apps/site/pages/%two_letters_code%/**/%original_file_name%
    content_segmentation: 0
    ignore:
      - /apps/site/pages/en/blog/**/*.mdx
      - /apps/site/pages/en/learn/**/*.mdx
    languages_mapping:
      two_letters_code:
        es-ES: es
        pt-BR: pt-br
        zh-CN: zh-cn
        zh-TW: zh-tw
  - source: /apps/site/i18n/locales/en.json
    translation: /apps/site/i18n/locales/%two_letters_code%.json
    languages_mapping:
      two_letters_code:
        es-ES: es
        pt-BR: pt-br
        zh-CN: zh-cn
        zh-TW: zh-tw

Everything else looks good! Before you merge this branch, please pause GitHub sync in Crowdin (otherwise, it will upload new /apps/site folders along with files). I will help to move the existing files in Crowdin project to the new path and then we can safely resume the sync. No new files will be uploaded in this case 👌

anthonyshew · 2024-06-25T15:37:09Z

Updated with that. Thank you!

package.json

github-actions · 2024-06-28T20:48:42Z

Running Lighthouse audit...

anthonyshew · 2024-07-03T21:19:03Z

I think I've gotten things as close as I can at this point without giving it another real run:

Squashed everything down to one commit for rebasing purposes
Hand-tested the blog post generation and Orama syncing scripts
Ran tests and lints on my fork to see them green
Updated the working directory for the Storybook Action

With that said, I think I'm ready to get labelled for another run again. 🙏

ovflowd · 2024-07-03T21:20:43Z

Thanks, @anthonyshew! Your work and effort is extremely appreciated!

I believe CI will fail in this branch but we can proceed with a merge if you are confident with things.

cc @nodejs/nodejs-website and @bmuenzenmeyer for a final PR review run 👀

anthonyshew · 2024-07-03T21:31:21Z

Looking through the CI errors on this run, these are all what I would expect to see from the changes I've made running against the Actions from main. I think I've accounted for all the failures I'm seeing but am prepared to be pseudo-on-call and quickly fix-forward as needed.

The Root Directory on Vercel will need to be updated to apps/site, which would earn these checks another green check mark if re-deployed with that setting. Even if not, you'd want to update that setting prior to merging, so that you get a good production deployment.

ovflowd · 2024-07-03T21:37:07Z

Gotcha! Ill give another review in a few minutes and Im fine with bearing the responsibilities of the merge.

ovflowd

It looks good to me. @bmuenzenmeyer note that Crowdin might break? But that's an issue to verify as a follow-up. I'm merging this now and going to observe what happens on the main branch

PR-URL: #53762 Refs: nodejs/nodejs.org#6850 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com>

PR-URL: nodejs#53762 Refs: nodejs/nodejs.org#6850 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com>

PR-URL: #53762 Refs: nodejs/nodejs.org#6850 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com>

vercel bot had a problem deploying to Preview June 19, 2024 17:10 Failure

anthonyshew changed the title ~~Starting off. The site builds, husky doesn't pass.~~ Scaffold multi-package workspace. Jun 19, 2024

vercel bot had a problem deploying to Preview June 19, 2024 17:18 Failure

vercel bot had a problem deploying to Preview June 23, 2024 20:28 Failure

vercel bot had a problem deploying to Preview June 23, 2024 20:41 Failure

vercel bot had a problem deploying to Preview June 23, 2024 20:58 Failure

vercel bot had a problem deploying to Preview June 23, 2024 22:05 Failure

anthonyshew commented Jun 23, 2024

View reviewed changes

vercel bot had a problem deploying to Preview June 23, 2024 22:18 Failure

vercel bot had a problem deploying to Preview June 24, 2024 14:56 Failure

vercel bot had a problem deploying to Preview June 24, 2024 19:17 Failure

vercel bot had a problem deploying to Preview June 24, 2024 20:01 Failure

vercel bot had a problem deploying to Preview June 24, 2024 23:26 Failure

vercel bot had a problem deploying to Preview June 25, 2024 15:08 Failure

This comment was marked as resolved.

Sign in to view

bmuenzenmeyer reviewed Jun 25, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

vercel bot had a problem deploying to Preview June 26, 2024 02:57 Failure

vercel bot had a problem deploying to Preview June 26, 2024 03:20 Failure

vercel bot had a problem deploying to Preview June 26, 2024 03:25 Failure

vercel bot had a problem deploying to Preview June 28, 2024 03:42 Failure

ovflowd added the github_actions:pull-request Trigger Pull Request Checks label Jun 28, 2024

github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jun 28, 2024

ovflowd had a problem deploying to Storybook June 28, 2024 20:48 — with GitHub Actions Failure

vercel bot deployed to Preview July 3, 2024 21:13 View deployment

ovflowd added the github_actions:pull-request Trigger Pull Request Checks label Jul 3, 2024

github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jul 3, 2024

ovflowd had a problem deploying to Storybook July 3, 2024 21:21 — with GitHub Actions Failure

ovflowd approved these changes Jul 3, 2024

View reviewed changes

ovflowd merged commit 3a455b2 into nodejs:main Jul 3, 2024
7 of 11 checks passed

Waldenesque mentioned this pull request Jul 4, 2024

v22.4.0 release blog post missing after pull 6850 "Scaffold multi-package workspace." #6894

Closed

anthonyshew mentioned this pull request Jul 4, 2024

fix: removed blog post #6897

Merged

5 tasks

Wellitsabhi mentioned this pull request Jul 12, 2024

Fix: Removed misleading information #6924

Merged

5 tasks

aduh95 mentioned this pull request Jul 17, 2024

doc: update release-post nodejs.org script nodejs/node#53762

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scaffold multi-package workspace. #6850

Scaffold multi-package workspace. #6850

anthonyshew commented Jun 19, 2024 •

edited

Loading

vercel bot commented Jun 19, 2024 •

edited

Loading

anthonyshew Jun 23, 2024 •

edited

Loading

bmuenzenmeyer commented Jun 24, 2024 •

edited

Loading

Andrulko commented Jun 24, 2024

anthonyshew commented Jun 24, 2024

Andrulko commented Jun 25, 2024

anthonyshew commented Jun 25, 2024

This comment was marked as resolved.

github-actions bot commented Jun 28, 2024

anthonyshew commented Jul 3, 2024

ovflowd commented Jul 3, 2024

anthonyshew commented Jul 3, 2024

ovflowd commented Jul 3, 2024

ovflowd left a comment

		# See https://turbo.build/repo/docs/reference/command-line-reference/run#--force
		run: echo "turbo_args=--force=true --cache-dir=.turbo/cache" >> "$GITHUB_OUTPUT"

Scaffold multi-package workspace. #6850

Scaffold multi-package workspace. #6850

Conversation

anthonyshew commented Jun 19, 2024 • edited Loading

Description

Validation

Anthony's Checklist

vercel bot commented Jun 19, 2024 • edited Loading

anthonyshew Jun 23, 2024 • edited Loading

Choose a reason for hiding this comment

bmuenzenmeyer commented Jun 24, 2024 • edited Loading

Andrulko commented Jun 24, 2024

anthonyshew commented Jun 24, 2024

Andrulko commented Jun 25, 2024

anthonyshew commented Jun 25, 2024

This comment was marked as resolved.

github-actions bot commented Jun 28, 2024

anthonyshew commented Jul 3, 2024

ovflowd commented Jul 3, 2024

anthonyshew commented Jul 3, 2024

ovflowd commented Jul 3, 2024

ovflowd left a comment

Choose a reason for hiding this comment

anthonyshew commented Jun 19, 2024 •

edited

Loading

vercel bot commented Jun 19, 2024 •

edited

Loading

anthonyshew Jun 23, 2024 •

edited

Loading

bmuenzenmeyer commented Jun 24, 2024 •

edited

Loading