Skip to content

Commit 0f4a814

Browse files
committed
new docs site, migrated to pnpm and nx
1 parent 47a3656 commit 0f4a814

File tree

796 files changed

+144304
-45162
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

796 files changed

+144304
-45162
lines changed

.changeset/config.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": true,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch",
10+
"ignore": []
11+
}
Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# Description
2-
3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4-
5-
Fixes # (issue)
6-
7-
If this is a new feature please add a description of what was added and why below:
8-
9-
## Type of change
10-
11-
Please delete options that are not relevant.
12-
13-
- [ ] Bug fix (non-breaking change which fixes an issue)
14-
- [ ] New feature (non-breaking change which adds functionality)
15-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16-
- [ ] This change requires a documentation update
17-
18-
# How Has This Been Tested?
19-
20-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
21-
22-
- [ ] Unit tests
23-
24-
# Checklist:
25-
26-
- [ ] My code follows the guidelines of this project
27-
- [ ] I have performed a self-review of my own code
28-
- [ ] I have commented my code, particularly in hard-to-understand areas
29-
- [ ] I have made corresponding changes to the documentation
30-
- [ ] My changes generate no new warnings or errors
31-
- [ ] I have added tests that prove my fix is effective or that my feature works
32-
- [ ] New and existing unit tests pass locally with my changes
33-
- [ ] Any dependent changes have been merged and published in downstream modules
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
If this is a new feature please add a description of what was added and why below:
8+
9+
## Type of change
10+
11+
Please delete options that are not relevant.
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] This change requires a documentation update
17+
18+
# How Has This Been Tested?
19+
20+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
21+
22+
- [ ] Unit tests
23+
24+
# Checklist:
25+
26+
- [ ] My code follows the guidelines of this project
27+
- [ ] I have performed a self-review of my own code
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings or errors
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
- [ ] Any dependent changes have been merged and published in downstream modules
Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,29 @@
1-
name: 🚀 pkg-pr-new
2-
concurrency:
3-
group: ${{ github.repository }}-${{ github.workflow }}-${{ github.ref }}
4-
cancel-in-progress: true
5-
on:
6-
push:
7-
branches: [main]
8-
pull_request:
9-
branches: [main]
10-
11-
jobs:
12-
build:
13-
runs-on: ubuntu-latest
14-
15-
steps:
16-
- name: Checkout code
17-
uses: actions/checkout@v2
18-
19-
- run: corepack enable
20-
- uses: actions/setup-node@v4
21-
with:
22-
node-version: 20
23-
cache: "npm"
24-
25-
- name: Install dependencies
26-
run: npm install
27-
28-
- name: Build
29-
run: npm run build
30-
31-
- run: npx pkg-pr-new publish
1+
name: 🚀 pkg-pr-new
2+
on: [push, pull_request]
3+
4+
concurrency:
5+
group: ${{ github.repository }}-${{ github.workflow }}-${{ github.ref }}
6+
cancel-in-progress: true
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v2
14+
15+
- name: Install pnpm
16+
uses: pnpm/action-setup@v4
17+
18+
- run: corepack enable
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version-file: "package.json"
22+
23+
- name: Install dependencies
24+
run: pnpm install
25+
26+
- name: Build
27+
run: pnpm run build
28+
29+
- run: npx pkg-pr-new publish ./packages/*
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: 📚🚀 Build documentation on release
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch: {}
7+
8+
concurrency:
9+
group: docs-build-${{ github.workflow }}-${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
build-docs:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
- name: Setup pnpm
21+
uses: pnpm/action-setup@v4
22+
- name: Setup Node
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version-file: "package.json"
26+
cache: "pnpm"
27+
28+
- name: Install deps
29+
run: pnpm install --prefer-offline --frozen-lockfile
30+
31+
- name: Generate docs
32+
working-directory: docs
33+
run: pnpm run generate:docs
34+
35+
deploy:
36+
name: 🚀 Deploy Release
37+
needs: [build-docs]
38+
runs-on: ubuntu-latest
39+
environment:
40+
name: docs-release
41+
steps:
42+
- uses: actions/checkout@v4
43+
- uses: forge-42/fly-deploy@v1.0.0-rc.2
44+
id: deploy
45+
env:
46+
FLY_ORG: ${{ vars.FLY_ORG }}
47+
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
48+
FLY_REGION: ${{ vars.FLY_REGION }}
49+
with:
50+
workspace_name: docs
51+
app_name: ${{github.event.repository.name}}-${{ github.ref_name }}
52+
use_isolated_workspace: true
53+
env_vars: |
54+
APP_ENV=production
55+
GITHUB_OWNER=${{ github.repository_owner }}
56+
GITHUB_REPO=${{ github.event.repository.name }}
57+
GITHUB_REPO_URL=https://github.com/${{ github.repository }}

.github/workflows/publish.yaml

Lines changed: 47 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
1-
name: Publish Package to npmjs
2-
on:
3-
release:
4-
types: [published]
5-
workflow_dispatch:
6-
7-
jobs:
8-
npm-publish:
9-
runs-on: ubuntu-latest
10-
steps:
11-
- uses: actions/checkout@v4
12-
# Setup .npmrc file to publish to npm
13-
- uses: actions/setup-node@v4
14-
with:
15-
node-version: "20.x"
16-
registry-url: "https://registry.npmjs.org"
17-
- run: npm ci
18-
- run: npm publish
19-
env:
20-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
21-
22-
23-
deploy-docs:
24-
name: "🚀 Deploy Docs"
25-
runs-on: ubuntu-latest
26-
environment:
27-
name: docs-release
28-
url: ${{ steps.deploy.outputs.app_url }}
29-
steps:
30-
- uses: actions/checkout@v4
31-
- uses: forge-42/fly-deploy@v1.0.0-rc.1
32-
id: deploy
33-
env:
34-
FLY_ORG: ${{ vars.FLY_ORG }}
35-
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
36-
FLY_REGION: fra
37-
with:
38-
workspace_name: docs
39-
app_name: react-router-devtools-docs-release
40-
use_isolated_workspace: true
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
release:
10+
name: Release
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
actions: write
16+
id-token: write
17+
steps:
18+
- name: Checkout Repo
19+
uses: actions/checkout@v3
20+
21+
- name: Install pnpm
22+
uses: pnpm/action-setup@v4
23+
24+
- name: Setup Node.js
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version-file: "package.json"
28+
29+
- name: Install Dependencies
30+
run: pnpm install
31+
32+
# - name: 🔐 Setup npm auth
33+
# run: |
34+
# echo "registry=https://registry.npmjs.org" >> ~/.npmrc
35+
# echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> ~/.npmrc
36+
37+
- name: Create Release Pull Request or Publish to npm
38+
id: changesets
39+
uses: changesets/action@v1
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
43+
with:
44+
title: "🚀 Release PR"
45+
commit: "chore: release"
46+
version: pnpm run version
47+
publish: pnpm run release

0 commit comments

Comments
 (0)