Skip to content
Apothem
أدلّة التشغيل

تأليف محوّل بيئة جديد

دليل تشغيلي لتأليف ونشر محوّل بيئة جديد لـ Apothem.

استخدم هذا الدليل التشغيلي عند تأليف محوّل بيئة جديد ليُدرَج بشكل أصيل في Apothem أو كحزمة طرف ثالث.

المتطلّبات المسبقة

الخطوات

1. نفِّذ المحوّل

اتبع مثال تأليف محوّل بيئة لتنفيذ HarnessAdapter للبيئة المستهدفة.

2. اكتب صفحة التوثيق

أنشئ site/content/docs/harnesses/<slug>.mdx يغطّي:

  • تدفّق التثبيت
  • تخطيط الملف التعريفي إلى التهيئة الأصلية
  • محاذير التوافق
  • وصفات التحقّق
  • وصفات التحديث وإلغاء التثبيت
  • سطح بوّابة المطابقة
  • جدول استكشاف الأخطاء وإصلاحها
  • جدول مقابض التهيئة

3. اكتب الاختبارات

tests/packaging/test_<slug>_adapter.py
tests/unit/test_<slug>_adapter.py

الحد الأدنى لتغطية الاختبارات:

  • test_install_creates_expected_files
  • test_verify_passes_after_install
  • test_uninstall_removes_files

4. تحقّق محليًا

apothem install --harness <slug>
apothem verify --harness <slug>
python -m apothem.conformity.gate --all .

5. قدِّم طلب السحب

افتح PR يتضمّن:

  • تنفيذ المحوّل
  • صفحة التوثيق في site/content/docs/harnesses/<slug>.mdx
  • الاختبارات
  • تسجيل نقطة الدخول في pyproject.toml
  • مدخل في سجلّ التغييرات

On this page