deploy to neocities
v3.0.0
Déployez efficacement un site Web en néocités à l'aide d'actions GitHub. Utilise la difficulté de conscience du contenu pour mettre à jour uniquement les fichiers qui ont changé.
Alternativement, vous pouvez utiliser l'assistance bin dans Async-Neocities pour se déployer vers les néocités localement depuis votre propre machine ainsi que dans CI.
name : Deploy to neocities
# only run on changes to main. Use main or master depending on whatever your default branch is called.
on :
push :
branches :
- main
concurrency : # prevent concurrent deploys doing strange things
group : deploy-to-neocities
cancel-in-progress : true
jobs :
deploy :
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v4
# Set up any tools and build steps here
# This example uses a Node.js toolchain to build a site
- name : Use Node.js
uses : actions/setup-node@v4
with :
node-version : lts/*
# If you have a different build process, replace this with your own build steps
- name : Install deps and build
run : |
npm i
npm run build
# When the dist_dir is ready, deploy it to neocities
- name : Deploy to neocities
uses : bcomnes/deploy-to-neocities@v3
with :
api_key : ${{ secrets.NEOCITIES_API_TOKEN }}
cleanup : false
neocities_supporter : false # set this to true if you have a supporter account and want to bypass unsuported files filter.
preview_before_deploy : true # print a deployment plan prior to waiting for files to upload.
dist_dir : public Créez un fichier de workflow .yml dans le répertoire .github/workflows de votre référentiel. Un exemple de workflow est disponible ci-dessus. Pour plus d'informations, référez la documentation d'aide GitHub pour créer un fichier de workflow.
Vous aurez besoin du jeton API pour votre site. Aller à:
https://neocities.org/settings/{{your-sitename}}#api_key
Obtenez le jeton API de votre site. Dans votre référentiel GitHub, définissez un secret appelé NEOCITIES_API_TOKEN . Définissez l'entrée api_token sur votre action deploy-to-neocities sur ${{ secrets.NEOCITIES_API_TOKEN }} comme dans l'exemple ci-dessus.
Pendant votre flux de travail, générez les fichiers que vous souhaitez déployer dans les néocités dans un répertoire. Définissez ceci en tant que répertoire dist_dir dans votre flux de travail (la valeur par défaut est public ). Vous pouvez utiliser tous les outils pour générer votre site qui peut être installé ou introduit dans l'environnement des actions GitHub.
Une fois la version terminée, deploy-to-neocities téléchargeront efficacement tous les fichiers nouveaux et tous modifiés en néocités. Tous les fichiers sur les néocités qui n'existent pas dans le dist_dir sont considérés comme des fichiers «orphelins». Pour supprimer destructivement ces fichiers «orphelins», définissez l'entrée cleanup sur true .
Vous ne souhaitez probablement que l'exécuter sur la branche master afin que les changements ne se soient pas engagés dans les résultats master dans les mises à jour du site Web. L'exécution d'une version de test qui ne se déploie pas sur toutes les succursales et PRS peut aider à prendre des modifications qui briseront la construction.
api_key ( OBLIQUE ): Le jeton API pour votre site Web Néocités.dist_dir : Le répertoire à déployer vers les néocités. Par défaut: public . Ne déploiez pas votre répertoire Root Repo (par ./ ). Il contient .git , .github et autres fichiers qui ne se déployeront pas correctement vers les néocités. Gardez-le propre en gardant ou en construisant votre site dans un subdir et en déploiez-le.neocoties_supporter : Définissez ceci sur true si vous avez un compte Néocités payé et souhaitez contourner le filtre de fichiers non pris en charge.cleanup : String booléen ( true ou false ). Si elle true , deploy-to-neocities supprimera les fichiers destructive sur les néotités que l'on ne trouve pas dans votre dist_dir . Par défaut: false .preview_before_deploy : Boolean String ( true ou false ). Si true , deploy-to-neocities imprimera un aperçu des fichiers qui seront téléchargés et supprimés. Par défaut: true .protected_files : une chaîne globulaire en option utilisée pour marquer les fichiers comme protégé. Les fichiers protégés ne sont jamais nettoyés. Testez cette option avec cleanup réglé sur False avant de vous en compter. Les fichiers protégés sont imprimés lorsque cleanup est défini sur True ou False. Les chaînes GLOB sont traitées par minimatch par rapport aux chemins de fichier de néocités distants. Les fichiers protégés peuvent toujours être mis à jour.Aucun.
Néocités offre un tas de belles propriétés:
A et AAAA sont tout ce dont vous avez besoin. Noms nus et tout!Voir Changelog.md
