Skip to content

Commit

Permalink
feat: migrate to use pnpm and add sitemapPlugin (runatlantis#4043)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
chenrui333 authored Feb 8, 2024
1 parent dffae12 commit aaa6ac0
Show file tree
Hide file tree
Showing 10 changed files with 2,389 additions and 1,846 deletions.
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ website:
- changed-files:
- any-glob-to-any-file: 'runatlantis.io/.vuepress/**/*'
- any-glob-to-any-file: 'package.json'
- any-glob-to-any-file: 'yarn.lock'
- any-glob-to-any-file: 'pnpm-lock.yaml'
2 changes: 1 addition & 1 deletion .github/renovate.json5
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
postUpdateOptions: [
"gomodTidy",
"gomodUpdateImportPaths",
"yarnDedupeHighest",
"pnpmDedupe",
],
// needed so e2e tests do not stomp over each other
prHourlyLimit: 1,
Expand Down
15 changes: 7 additions & 8 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
filters: |
src:
- '**.js'
- 'yarn.lock'
- 'pnpm-lock.yaml'
- 'package.json'
- '.github/workflows/website.yml'
Expand All @@ -48,24 +48,23 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
- uses: wyvox/action-setup-pnpm@v3
with:
node-version-file: .node-version
node-version: 20

- name: run http-server
env:
# renovate: datasource=github-releases depName=raviqqe/muffet
MUFFET_VERSION: 2.9.3
run: |
npm install -g yarn
# install raviqqe/muffet to check for broken links.
curl -Ls https://github.com/raviqqe/muffet/releases/download/v${MUFFET_VERSION}/muffet_linux_amd64.tar.gz | tar -xz
# build the site
yarn && yarn website:build
# build site
pnpm install
pnpm website:build
# run http-server for muffet to check the links
# start http-server for integration testing
npx http-server runatlantis.io/.vuepress/dist &
- name: wait until server listened
Expand Down
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pnpm 8.12.0
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
We take security issues seriously. Please report a security vulnerability to the maintainers using [private vulnerability reporting](https://github.com/runatlantis/atlantis/security/advisories/new).

# Updating The Website
* To view the generated website locally, run `yarn website:dev` and then
* To view the generated website locally, run `pnpm website:dev` and then
open your browser to http://localhost:8080.
* The website will be regenerated when your pull request is merged to main.

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ end-to-end-tests: ## Run e2e tests

.PHONY: website-dev
website-dev: ## Run runatlantic.io on localhost:8080
yarn website:dev
pnpm website:dev
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
{
"license": "Apache-2.0",
"devDependencies": {
"@vuepress/client": "2.0.0-rc.0",
"@vuepress/plugin-docsearch": "2.0.0-rc.0",
"@vuepress/plugin-google-analytics": "2.0.0-rc.0",
"vuepress": "2.0.0-rc.0"
"@vuepress/utils": "2.0.0-rc.0",
"vue": "^3.3.11",
"vuepress": "2.0.0-rc.0",
"vuepress-plugin-sitemap2": "2.0.0-rc.4"
},
"scripts": {
"website:dev": "vuepress dev runatlantis.io",
Expand Down
Loading

0 comments on commit aaa6ac0

Please sign in to comment.