Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: migrate to use pnpm and add sitemapPlugin #4043

Merged
merged 4 commits into from
Feb 8, 2024
Merged

Conversation

chenrui333
Copy link
Member

@chenrui333 chenrui333 commented Dec 12, 2023

what

initially was just thinking to include the vuepress-plugin-sitemap2 plugin, but it does not support yarn 1.x (aka classic yarn), thus migrating to use pnpm (latest and greatest nodejs package manager), and include/update dependencies (per the vuepress 2.x doc, needs to include some peer dependencies, vue and @vuepress/client)

why

trying to add sitemap.xml support for SEO

image

tests

  • install pnpm 8.12.0
  • pnpm install
  • pnpm website:dev
  • pnpm website:build

website:build run

$ pnpm website:build

> @ website:build /Users/rui/open-source/atlantis
...
vuepress-plugin-sitemap2:  ✔ Generating sitemap to /sitemap.xml
success VuePress build completed in 4.15s!
$ cat runatlantis.io/.vuepress/dist/sitemap.xml
<?xml version="1.0" encoding="UTF-8"?>

references

@chenrui333 chenrui333 requested a review from a team as a code owner December 12, 2023 21:56
@github-actions github-actions bot added dependencies PRs that update a dependency file github-actions website labels Dec 12, 2023
@chenrui333 chenrui333 marked this pull request as draft December 12, 2023 22:08
@chenrui333
Copy link
Member Author

netlify side needs some config change per this PR

image

@chenrui333 chenrui333 marked this pull request as ready for review December 12, 2023 22:56
add `vue` and `@vuepress/client` as peer-dependencies

stick with node 20

update @vuepress/plugin-docsearch dep with `npx vp-update`

add vuepress-plugin-sitemap2 plugin

Signed-off-by: Rui Chen <rui@chenrui.dev>
Signed-off-by: Rui Chen <rui@chenrui.dev>
Signed-off-by: Rui Chen <rui@chenrui.dev>
Signed-off-by: Rui Chen <rui@chenrui.dev>
@chenrui333 chenrui333 requested a review from a team as a code owner February 8, 2024 20:20
@chenrui333 chenrui333 requested review from lukemassa and X-Guardian and removed request for a team February 8, 2024 20:20
@jamengual
Copy link
Contributor

/cherry-pick release-0.27.1

@jamengual jamengual merged commit aaa6ac0 into main Feb 8, 2024
25 checks passed
@jamengual jamengual deleted the pnpm-sitemapPlugin branch February 8, 2024 20:26
terakoya76 pushed a commit to terakoya76/atlantis that referenced this pull request Dec 31, 2024
* migrate off yarn to pnpm

add `vue` and `@vuepress/client` as peer-dependencies

stick with node 20

update @vuepress/plugin-docsearch dep with `npx vp-update`

add vuepress-plugin-sitemap2 plugin

Signed-off-by: Rui Chen <rui@chenrui.dev>

* replace yarn.lock with pnpm-lock.yaml for labeler

Signed-off-by: Rui Chen <rui@chenrui.dev>

* replace yarnDedupeHighest with pnpmDedupe for renovate

Signed-off-by: Rui Chen <rui@chenrui.dev>

* update website-lint job

Signed-off-by: Rui Chen <rui@chenrui.dev>

---------

Signed-off-by: Rui Chen <rui@chenrui.dev>
kvanzuijlen pushed a commit to kvanzuijlen/atlantis that referenced this pull request Jan 4, 2025
* migrate off yarn to pnpm

add `vue` and `@vuepress/client` as peer-dependencies

stick with node 20

update @vuepress/plugin-docsearch dep with `npx vp-update`

add vuepress-plugin-sitemap2 plugin

Signed-off-by: Rui Chen <rui@chenrui.dev>

* replace yarn.lock with pnpm-lock.yaml for labeler

Signed-off-by: Rui Chen <rui@chenrui.dev>

* replace yarnDedupeHighest with pnpmDedupe for renovate

Signed-off-by: Rui Chen <rui@chenrui.dev>

* update website-lint job

Signed-off-by: Rui Chen <rui@chenrui.dev>

---------

Signed-off-by: Rui Chen <rui@chenrui.dev>
Signed-off-by: kvanzuijlen <8818390+kvanzuijlen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies PRs that update a dependency file github-actions website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants