deploy to neocities
v3.0.0
نشر موقع ويب بكفاءة على NEOCITIS باستخدام إجراءات github. يستخدم المحتوى الذي يدرك الانتشار لتحديث الملفات التي تغيرت فقط.
بدلاً من ذلك ، يمكنك استخدام مساعد الصندوق في الآثار غير المتزامنة للنشر على NEOCITIS محليًا من الجهاز الخاص بك وكذلك في 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 }} كما في المثال أعلاه.
أثناء سير العمل الخاص بك ، قم بإنشاء الملفات التي تريد نشرها على NEOCITIS في دليل. اضبط هذا كدليل dist_dir في سير العمل الخاص بك (الافتراضي هو public ). يمكنك استخدام أي أدوات لإنشاء موقعك يمكن تثبيته أو إحضاره إلى بيئة إجراءات GitHub.
بمجرد اكتمال البناء ، سيتم تحميل deploy-to-neocities بكفاءة جميع الملفات الجديدة وجميع الملفات التي تم تغييرها إلى Neocists. تعتبر أي ملفات على NEOCITIS غير موجودة في dist_dir ملفات "يتيمة". لإزالة هذه الملفات "اليتيم" بشكل مدمرة ، قم بتعيين إدخال cleanup على true .
من المرجح أن ترغب فقط في تشغيل هذا على الفرع master بحيث لا تتغير سوى التغييرات الملتزمة بالنتائج master في تحديثات موقع الويب. يمكن تشغيل إنشاء اختبار لا يتم نشره على جميع الفروع ويمكن أن يساعد PRS في التقاط التغييرات التي من شأنها كسر البناء.
api_key ( مطلوب ): رمز API لموقع NEOCITIS الخاص بك لنشره.dist_dir : الدليل للنشر على Neocists. الافتراضي: public . لا تنشر دليل ريبو الجذر الخاص بك (على سبيل المثال ./ ). أنه يحتوي على .git و .github والملفات الأخرى التي لن تنتشر بشكل صحيح إلى NEOCITIS. اجعله نظيفًا عن طريق الحفاظ على موقعك أو بناء موقعك في فرعي ونشره.neocoties_supporter : قم بتعيين هذا إلى true إذا كان لديك حساب NEOCITIS مدفوعًا وترغب في تجاوز مرشح الملفات غير المدعومة.cleanup : سلسلة منطقية ( true أو false ). إذا كان true ، فسيقوم deploy-to-neocities بحذف الملفات الموجودة على neociets غير موجودة في dist_dir . الافتراضي: false .preview_before_deploy : سلسلة منطقية ( true أو false ). إذا كان true ، فستطبع deploy-to-neocities معاينة الملفات التي سيتم تحميلها وحذفها. الافتراضي: true .protected_files : سلسلة غلبة اختيارية تستخدم لتمييز الملفات وفقًا للحماية. لا يتم تنظيف الملفات المحمية أبدًا. اختبر هذا الخيار مع تعيين cleanup إلى خطأ قبل الاعتماد عليه. تتم طباعة الملفات المحمية عند ضبط cleanup على صواب أو خطأ. تتم معالجة سلاسل الكرة الأرضية بواسطة Minimatch مقابل مسارات ملفات NEOCOTE عن بعد. لا يزال من الممكن تحديث الملفات المحمية.لا أحد.
تقدم Neocities مجموعة من الخصائص الجميلة:
A و AAAA البسيطة هي كل ما تحتاجه. أسماء عارية وكل شيء!انظر changelog.md
