Skip to content

Commit 7017599

Browse files
AlemTuzlakabrulic
AlemTuzlak
and
abrulic
authored
Migrate docs to our template (#221)
* new docs site, migrated to pnpm and nx * remove nx * fix action * fix action * test * test * test * add .npmrc * fix rc * fix deployment * fix deployment? * fix deployment? * fix * update dockerfile * biome removed, updated pnpm version in dockerfile * deployment fix? * deployment fix? * deployment fix? * deployment fix? * deployment fix? * deployment fix? * deployment fix? * deployment fix? * updates in yml, generate-docs, dockerfile * updates in yml, generate-docs, dockerfile * update package-json * update package-json * UI tw fixes * comments * small fix * small UI fix * UI fixes * small comment in dockerfile * UI small fix * UI fixes * small fix in docs * docs update --------- Co-authored-by: abrulic <[email protected]>
1 parent 47a3656 commit 7017599

File tree

595 files changed

+27519
-45216
lines changed

Some content is hidden

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

595 files changed

+27519
-45216
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/[email protected]/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+
}

‎pull_request_template.md‎ renamed to ‎.github/pull_request_template.md‎

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

‎.github/workflows/publish-commit.yaml‎

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:all
28+
29+
- run: npx pkg-pr-new publish ./packages/*

‎.github/workflows/publish-documentation.yaml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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+
name: Build Docs
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Setup pnpm
23+
uses: pnpm/action-setup@v4
24+
25+
- name: Setup Node
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version-file: "package.json"
29+
cache: pnpm
30+
31+
- name: Install deps
32+
run: pnpm install --prefer-offline --frozen-lockfile
33+
34+
- name: Generate docs
35+
working-directory: docs
36+
env:
37+
APP_ENV: production
38+
run: pnpm run generate:docs
39+
40+
- name: Pack generated docs (tarball)
41+
run: |
42+
tar -czf docs-generated.tgz -C docs generated-docs
43+
ls -lh docs-generated.tgz
44+
45+
- name: Upload generated docs (tgz)
46+
uses: actions/upload-artifact@v4
47+
with:
48+
name: docs-generated-tgz
49+
path: docs-generated.tgz
50+
if-no-files-found: error
51+
52+
- name: Upload versions file
53+
uses: actions/upload-artifact@v4
54+
with:
55+
name: docs-versions
56+
path: docs/app/utils/versions.ts
57+
if-no-files-found: error
58+
59+
deploy-docs-on-release:
60+
needs: [build-docs]
61+
name: Deploy Docs
62+
environment:
63+
name: docs-release
64+
runs-on: ubuntu-latest
65+
steps:
66+
- uses: actions/checkout@v4
67+
68+
- name: Download generated docs (tgz)
69+
uses: actions/download-artifact@v4
70+
with:
71+
name: docs-generated-tgz
72+
path: .
73+
74+
- name: Unpack generated docs into docs/
75+
run: |
76+
set -euxo pipefail
77+
tar -xzf docs-generated.tgz -C docs
78+
ls -laR docs/generated-docs | sed -n '1,200p'
79+
80+
- name: Download versions file
81+
uses: actions/download-artifact@v4
82+
with:
83+
name: docs-versions
84+
path: docs/app/utils
85+
86+
- uses: forge-42/[email protected]
87+
id: deploy
88+
env:
89+
FLY_ORG: ${{ vars.FLY_ORG }}
90+
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
91+
FLY_REGION: ${{ vars.FLY_REGION }}
92+
with:
93+
workspace_name: docs
94+
app_name: ${{github.event.repository.name}}-${{ github.ref_name }}
95+
use_isolated_workspace: true
96+
env_vars: |
97+
APP_ENV=production
98+
GITHUB_OWNER=${{ github.repository_owner }}
99+
GITHUB_REPO=${{ github.event.repository.name }}
100+
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/[email protected]
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)