Déployer un site web
Vue d'ensemble
Utilisez cette compétence pour guider le déploiement d'un site web déjà généré vers GitHub Pages. Le projet attendu est un site statique Astro stocké dans un dépôt GitHub, avec les fichiers sources commités et le déploiement géré par GitHub Actions.
Cette compétence suppose que le site web lui-même existe déjà. Ne reconcevez pas le site sauf si l'utilisateur le demande.
Modèle de déploiement
Utilisez cette configuration pour le flux de travail actuel du site personnel :
- Suivez le code source dans Git.
- Ignorez les dossiers générés ou de dépendances tels que
node_modules/,dist/,.astro/ettmp/. - Construisez le site avec
npm.cmd run build. - Déployez depuis GitHub Actions vers GitHub Pages.
- Conservez le développement local sur
http://localhost:4321/. - Utilisez un chemin
baseAstro uniquement lors des builds GitHub Actions pour les URL de projet Pages telles quehttps://USERNAME.github.io/REPOSITORY/.
Avant le déploiement
Vérifiez l'état de préparation avec des commandes légères :
git status
npm.cmd run build
Confirmez que ces fichiers ou paramètres existent :
package.jsonastro.config.mjs.gitignore.github/workflows/deploy.ymlsrc/public/
Pour ce projet, astro.config.mjs doit prendre en charge les builds locales et GitHub Pages, par exemple :
import { defineConfig } from "astro/config";
const isGithubPagesBuild = process.env.GITHUB_ACTIONS === "true";
export default defineConfig({
site: "https://USERNAME.github.io",
base: isGithubPagesBuild ? "/REPOSITORY" : "/",
});
Utilisez des helpers d'URL dans les pages/layouts Astro lors de la création de liens vers des assets publics locaux ou des pages internes :
const base = import.meta.env.BASE_URL;
const url = (path: string) => {
const normalizedBase = base.endsWith("/") ? base : `${base}/`;
const normalizedPath = path.replace(/^\/+/, "");
return `${normalizedBase}${normalizedPath}`;
};
Workflow GitHub Actions
Utilisez un workflow Pages comme celui-ci :
name: Deploy to GitHub Pages
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Build with Astro
uses: withastro/action@v6
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
Expliquez les actions simplement si nécessaire :
actions/checkout@v7: télécharge le dépôt dans l'environnement d'exécution GitHub Actions.withastro/action@v6: installe les dépendances, construit le site Astro et prépare l'artefact Pages.actions/deploy-pages@v5: publie l'artefact construit sur GitHub Pages.
Le suffixe @vN épingle une version majeure de l'action.
Dépôt et étapes de commit
Guide l'utilisateur pour commiter et pousser les modifications sources prêtes pour le déploiement :
git status
git add .
git commit -m "Préparer le déploiement du site web"
git push origin main
Si Git signale des avertissements de fin de ligne tels que LF will be replaced by CRLF, expliquez qu'il s'agit d'un avertissement de normalisation de fin de ligne Windows et que cela ne bloque généralement pas le déploiement.
Si Git signale qu'aucune identité utilisateur n'est configurée, configurez l'identité du dépôt ou globale avant de commiter. Si la confidentialité est importante, utilisez l'adresse e-mail noreply de l'utilisateur GitHub.
Paramètres GitHub Pages
Guide l'utilisateur dans GitHub :
- Ouvrez le dépôt sur GitHub.
- Allez dans
Settings. - Allez dans
Pages. - Sous
Build and deployment, définissezSourcesurGitHub Actions. - Enregistrez si GitHub affiche un bouton d'enregistrement.
- Allez dans l'onglet
Actionset ouvrez la dernière exécution de déploiement. - Attendez que le workflow réussisse.
- Ouvrez l'URL Pages affichée par GitHub.
Pour un site projet, l'URL attendue est généralement :
https://USERNAME.github.io/REPOSITORY/
Vérification
Après le déploiement, vérifiez :
- La page d'accueil se charge.
- Les liens de navigation fonctionnent.
- Les images se chargent.
- Les fichiers téléchargeables, tels que le CV PDF, s'ouvrent correctement.
- L'URL du navigateur inclut le chemin du dépôt pour les pages de projet.
- Aucun chemin cassé comme
/REPOSITORYprojects,/REPOSITORYprofile.jpgou/REPOSITORYfile.pdfn'apparaît dans le HTML généré.
Si le site déployé est cassé mais que l'aperçu local fonctionne, vérifiez d'abord la gestion du chemin de base.
Si GitHub Actions échoue, inspectez l'étape en échec :
- Échec du checkout : problème de dépôt ou de permission.
- Échec de l'installation/construction : problème de dépendance, Astro ou code source.
- Échec du déploiement : problème de source/permission/paramètres GitHub Pages.
Critères d'achèvement
Considérez la tâche de déploiement comme terminée lorsque :
- La construction locale réussit.
- Les modifications sources sont commitées et poussées.
- La source GitHub Pages est définie sur GitHub Actions.
- L'exécution du déploiement Actions réussit.
- L'URL publique Pages charge correctement le site web.