Skip to content

Commit a5a4de0

Browse files
committed
docs: add PROJECT_NAME repository variable
1 parent ff07e55 commit a5a4de0

5 files changed

Lines changed: 18 additions & 10 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy explainer
1+
name: Deploy
22

33
on:
44
push:
@@ -128,7 +128,7 @@ jobs:
128128
with:
129129
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
130130
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
131-
command: pages deploy dist --project-name=explainer-docs
131+
command: pages deploy dist --project-name=${{ vars.PROJECT_NAME }}-docs
132132

133133
deploy-blog:
134134
needs: build-blog
@@ -146,7 +146,7 @@ jobs:
146146
with:
147147
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
148148
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
149-
command: pages deploy dist --project-name=explainer-blog
149+
command: pages deploy dist --project-name=${{ vars.PROJECT_NAME }}-blog
150150

151151
deploy-website:
152152
needs: build-website
@@ -164,4 +164,4 @@ jobs:
164164
with:
165165
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
166166
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
167-
command: pages deploy dist --project-name=explainer-website
167+
command: pages deploy dist --project-name=${{ vars.PROJECT_NAME }}-website

apps/docs/src/content/docs/explainer/default/en/deployment/ci-cd.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ These are required for cross-app navigation links. Set them in GitHub Settings
9797
| `PUBLIC_DOCS_URL` | Docs app URL | `https://docs.explainer.dev` |
9898
| `PUBLIC_BLOG_URL` | Blog app URL | `https://blog.explainer.dev` |
9999
| `DEPLOY_TARGET` | Deployment platform | `cloudflare` |
100+
| `PROJECT_NAME` | Cloudflare Pages project name prefix | `explainer` |
100101

101102
:::callout{variant="info"}
102103
All three `PUBLIC_*` variables are passed to every app build. This ensures navbar links between apps always point to the correct URLs, regardless of the deployment platform.

apps/docs/src/content/docs/explainer/default/en/deployment/cloudflare.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ Deploy Explainer apps to Cloudflare Pages using GitHub Actions with the `cloudfl
1313

1414
::::step-group
1515
:::step{title="Set the deploy target"}
16-
Add a repository variable in GitHub Settings → Variables:
16+
Add the following repository variables in GitHub Settings → Secrets and variables → Actions → **Variables** tab:
1717

1818
```text
1919
DEPLOY_TARGET=cloudflare
20+
PROJECT_NAME=your-project-name
2021
```
22+
23+
`PROJECT_NAME` is used to name the Cloudflare Pages projects. For example, `PROJECT_NAME=explainer` produces `explainer-docs`, `explainer-blog`, and `explainer-website`.
2124
:::
2225

2326
:::step{title="Add required secrets"}
@@ -43,9 +46,9 @@ The unified workflow at `.github/workflows/deploy.yml` handles all three apps. W
4346
with:
4447
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
4548
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
46-
command: pages deploy dist --project-name=explainer-docs
49+
command: pages deploy dist --project-name=${{ vars.PROJECT_NAME }}-docs
4750
```
4851
4952
:::callout{variant="info"}
50-
Replace `explainer-docs` with your Cloudflare Pages project name. Each app needs its own project. See the [CI/CD](/explainer/deployment/ci-cd) page for the full workflow structure.
53+
The project name is built from `PROJECT_NAME` + the app suffix (`-docs`, `-blog`, `-website`). Each app must have a matching project in the Cloudflare dashboard. See the [CI/CD](/explainer/deployment/ci-cd) page for the full workflow structure.
5154
:::

apps/docs/src/content/docs/explainer/default/fr/deployment/ci-cd.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Celles-ci sont nécessaires pour les liens de navigation entre applications. Dé
9797
| `PUBLIC_DOCS_URL` | URL de l'application Docs | `https://docs.explainer.dev` |
9898
| `PUBLIC_BLOG_URL` | URL de l'application Blog | `https://blog.explainer.dev` |
9999
| `DEPLOY_TARGET` | Plateforme de déploiement | `cloudflare` |
100+
| `PROJECT_NAME` | Préfixe du nom de projet Cloudflare Pages | `explainer` |
100101

101102
:::callout{variant="info"}
102103
Les trois variables `PUBLIC_*` sont transmises à chaque compilation d'application. Cela garantit que les liens de la barre de navigation entre les applications pointent toujours vers les bonnes URL, quelle que soit la plateforme de déploiement.

apps/docs/src/content/docs/explainer/default/fr/deployment/cloudflare.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ Déployez les applications Explainer sur Cloudflare Pages avec GitHub Actions en
1313

1414
::::step-group
1515
:::step{title="Définir la cible de déploiement"}
16-
Ajoutez une variable de dépôt dans GitHub Settings → Variables :
16+
Ajoutez les variables de dépôt suivantes dans GitHub Settings → Secrets and variables → Actions → onglet **Variables** :
1717

1818
```text
1919
DEPLOY_TARGET=cloudflare
20+
PROJECT_NAME=nom-de-votre-projet
2021
```
22+
23+
`PROJECT_NAME` est utilisé pour nommer les projets Cloudflare Pages. Par exemple, `PROJECT_NAME=explainer` génère `explainer-docs`, `explainer-blog` et `explainer-website`.
2124
:::
2225

2326
:::step{title="Ajouter les secrets requis"}
@@ -43,9 +46,9 @@ Le workflow unifié situé dans `.github/workflows/deploy.yml` gère les trois a
4346
with:
4447
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
4548
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
46-
command: pages deploy dist --project-name=explainer-docs
49+
command: pages deploy dist --project-name=${{ vars.PROJECT_NAME }}-docs
4750
```
4851
4952
:::callout{variant="info"}
50-
Remplacez `explainer-docs` par le nom de votre projet Cloudflare Pages. Chaque application nécessite son propre projet. Consultez la page [CI/CD](/explainer/deployment/ci-cd) pour la structure complète du workflow.
53+
Le nom du projet est construit à partir de `PROJECT_NAME` + le suffixe de l'application (`-docs`, `-blog`, `-website`). Chaque application doit avoir un projet correspondant dans le tableau de bord Cloudflare. Consultez la page [CI/CD](/explainer/deployment/ci-cd) pour la structure complète du workflow.
5154
:::

0 commit comments

Comments
 (0)