deploy to neocities
v3.0.0
Эффективно развернуть веб -сайт для неотшивок, используя действия GitHub. Использует контент, осведомленные, чтобы обновить только файлы, которые изменились.
В качестве альтернативы, вы можете использовать помощника бин в асинхронных неотъемках для развертывания в неофиале локально от вашей собственной машины, а также в 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 Создайте файл .yml .github/workflows . Пример рабочий процесс доступен выше. Для получения дополнительной информации ссылайтесь на документацию по справочной информации GitHub для создания файла рабочего процесса.
Вам понадобится токен API для вашего сайта. Перейти к:
https://neocities.org/settings/{{your-sitename}}#api_key
Получите токен API вашего сайта. В вашем репозитории GitHub установите секрет NEOCITIES_API_TOKEN . Установите ввод api_token на ваше действие deploy-to-neocities в ${{ secrets.NEOCITIES_API_TOKEN }} как в примере выше.
Во время вашего рабочего процесса сгенерируйте файлы, которые вы хотите развернуть в нехватчиках в каталог. Установите это как каталог dist_dir в вашем рабочем процессе (по умолчанию public ). Вы можете использовать любые инструменты для создания вашего сайта, которые могут быть установлены или привезены в среду Action Github.
Как только сборка будет завершена, deploy-to-neocities будет эффективно загружать все новые и все изменившиеся файлы в неща. Любые файлы о неофиале, которые не существуют в dist_dir считаются «сиротыми» файлами. Чтобы разрушить эти «осиротевшие» файлы, установите ввод cleanup в true .
Скорее всего, вы только хотите запустить это в master филиале, чтобы изменить только master -результат в обновлениях веб -сайтов. Запуск тестовой сборки, которая не развертывается на всех филиалах, и PRS может помочь поймать изменения, которые разорвут сборку.
api_key ( требуется ): токен API для вашего веб -сайта NeoTisities для развертывания.dist_dir : каталог для развертывания в неочетах. По умолчанию: public . Не разверните свой каталог Root Repo (например ./ ). Он содержит .git , .github и другие файлы, которые не будут должным образом развертываться в неочетах. Держите его в чистоте, удерживая или превращая свой сайт в поддир и разверните его.neocoties_supporter : установите это в true если у вас есть платная учетная запись неочетов и вы хотите обойти невыполненную фильтр файлов.cleanup : логическая строка ( true или false ). Если true , deploy-to-neocities деструктивно удаляет файлы, найденные в неяде, не найденных в вашем dist_dir . По умолчанию: false .preview_before_deploy : boolean string ( true или false ). Если true , deploy-to-neocities напечатает предварительный просмотр файлов, которые будут загружены и удалены. По умолчанию: true .protected_files : необязательная глобальная строка, используемая для маркировки файлов в качестве защищенных. Защищенные файлы никогда не очищаются. Проверьте эту опцию с помощью cleanup , установленной на False, прежде чем полагаться на нее. Защищенные файлы напечатаны, когда cleanup установлена на TRUE или FALSE. Строки глобуса обрабатываются минимальными по сравнению с путами файлов отдаленных неочетов. Защищенные файлы все еще могут быть обновлены.Никто.
Неоционирования предлагает кучу хороших свойств:
A и AAAA - это все, что вам нужно. Голые имена и все!Смотрите Changelog.md
