كيفية إنشاء ملف Makefile ذاتي التوثيق لتحسين سير عمل DevOps

تبسيط سير العمل: قوة ملفات Makefile ذاتية التوثيق في DevOps

في عالم تطوير البرمجيات سريع الوتيرة، تُعد الكفاءة وأتمتة المهام أمراً بالغ الأهمية. غالباً ما يجد المطورون أنفسهم يكررون نفس الأوامر لإعداد بيئات العمل، تثبيت التبعيات، أو تشغيل الخوادم المحلية. تخيل لو كان بإمكانك تحويل هذه المهام المتكررة إلى أوامر بسيطة وموحدة لمشروعك؟ هنا تبرز قوة ملفات Makefile.

ملف Makefile، عند استخدامه بذكاء، يمكن أن يكون أداة لا تقدر بثمن في بيئة DevOps، ليس فقط لتبسيط المهام ولكن أيضاً لتوثيقها ذاتياً. هذا يعني أن المطورين الجدد يمكنهم البدء في العمل على مشروعك دون الحاجة إلى قضاء ساعات في البحث عن الأوامر الصحيحة أو نسخها ولصقها من ملف README طويل.

تحديات الإعداد اليدوي للمشاريع

دعنا نلقي نظرة على سيناريو شائع. عندما ينضم مطور جديد إلى فريقك، قد يواجه سلسلة طويلة ومعقدة من الأوامر لإعداد بيئة التطوير الخاصة به. قد تبدو هذه الأوامر كالتالي:

pip3 install pipenv
pipenv shell --python 3.8
pipenv install --dev
npm install
pre-commit install --install-hooks
# look up how to install Framework X...
# copy and paste from README...
npm run serve

هذه العملية ليست مملة فحسب، بل هي أيضاً عرضة للأخطاء وتستغرق وقتاً طويلاً. ماذا لو كان هناك طريقة أفضل؟

كيف يغير Make الوضع؟

باستخدام ملف Makefile، يمكنك دمج كل هذه الأوامر في أمر واحد بسيط وواضح. بدلاً من السلسلة الطويلة أعلاه، يمكن للمطور الجديد البدء بالعمل فوراً بمجرد كتابة:

make start

هذا التحول يقلل بشكل كبير من منحنى التعلم، ويزيد من سعادة المطورين، ويضمن اتساق بيئات التطوير عبر الفريق بأكمله.

لماذا يعتبر Make أداة لا غنى عنها للمطورين؟

يستخدم العديد من المطورين أداة make يومياً لإزالة الملل من الأنشطة الشائعة مثل تحديث البرامج، تثبيت التبعيات، وإجراء الاختبارات. لتحقيق كل هذا باستخدام ملف Makefile (خاصةً GNU make)، فإننا نعتمد على Makefile rules (قواعد Makefile) و recipes (وصفات التنفيذ). توجد مفاهيم مماثلة لأنواع أخرى من make المتوافقة مع POSIX، مثل Target Rules.

أمثلة عملية لقواعد Makefile

دعنا نستعرض بعض الأمثلة التي توضح كيف يمكننا جعل المهام أسهل باستخدام make:

update: ## Do apt upgrade and autoremove
	sudo apt update && sudo apt upgrade -y
	sudo apt autoremove -y

env:
	pip3 install pipenv
	pipenv shell --python 3.8

install: ## Install or update dependencies
	pipenv install --dev
	npm install
	pre-commit install --install-hooks

serve: ## Run the local development server
	hugo serve --enableGitInfo --disableFastRender --environment development

initial: update env install serve ## Install tools and start development development server

في هذا المثال، قمنا بإنشاء مجموعة من الأوامر المختصرة (aliases) التي يمكن دمجها مع مستودع مشروعك. لاحظ التعليقات الغريبة التي تبدأ بـ ##. هذه ليست مجرد تعليقات عادية؛ إنها المفتاح لإنشاء ملف Makefile ذاتي التوثيق.

الوثائق الذاتية: الارتقاء بملف Makefile إلى مستوى جديد

تُعد الأوامر المختصرة رائعة، ولكن فقط إذا كنت تتذكر ما هي وماذا تفعل دون الحاجة إلى كتابة cat Makefile باستمرار. هنا يأتي دور أمر المساعدة (help command) الذي يجعل ملف Makefile يوثق نفسه بنفسه.

بناء أمر المساعدة (help command)

لإنشاء أمر help الذي يعرض جميع الأوامر المتاحة ووصفها، يمكننا إضافة القاعدة التالية إلى ملف Makefile الخاص بنا:

.PHONY : help
help: ## Show this help
	@egrep -h '\s ##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

دعنا نحلل هذا السطر السحري من أوامر سطر الأوامر:

• .PHONY : help: يخبر make أن help هو هدف زائف (phony target)، مما يعني أنه لا يمثل ملفاً حقيقياً.
• egrep -h '\s ##\s' $(MAKEFILE_LIST): يبحث هذا الأمر عن جميع الأسطر التي تحتوي على النمط ## في جميع ملفات Makefile المدرجة في متغير البيئة $(MAKEFILE_LIST).
• sort: يقوم بفرز المخرجات أبجدياً لسهولة القراءة.
• awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}': هذا هو الجزء الذي يقوم بالتنسيق. يقوم بتعيين فاصل الحقول (FS) ليكون :.*?## ، ثم يطبع الحقل الأول ($$1، وهو اسم الهدف) والحقل الثاني ($$2، وهو الوصف) بتنسيق ملون ومرتب. تُستخدم \033[36m و \033[0m لإضافة ألوان إلى النص في الطرفية.

لضمان أن يكون أمر help هو الهدف الافتراضي، يمكننا وضعه في الجزء العلوي من ملف Makefile.

تجربة ملف Makefile ذاتي التوثيق

الآن، لرؤية جميع اختصاراتنا المفيدة وما تفعله، ما علينا سوى تشغيل make أو make help في سطر الأوامر. ستكون النتيجة مشابهة لما يلي:

help                 Show this help
initial              Install tools and start development server
install              Install or update dependencies
serve                Run the local development server
update               Do apt upgrade and autoremove

تهانينا! لقد أصبح لديك الآن أداة سطر أوامر (CLI tool) مخصصة لمشروعك وذاتية التوثيق. إن إمكانيات تحسين سير عمل DevOps باستخدام ملف Makefile ذاتي التوثيق لا حصر لها تقريباً. يمكنك استخدامها لتبسيط أي سير عمل، مما يؤدي إلى فريق تطوير أكثر سعادة وإنتاجية.

الخلاصة التقنية

يُعد ملف Makefile ذاتي التوثيق استثماراً ذكياً لأي مشروع تطوير، خاصة في بيئات DevOps المعقدة. إنه لا يقتصر على أتمتة المهام المتكررة فحسب، بل يعزز أيضاً قابلية اكتشاف الأوامر ويسهل عملية إعداد المطورين الجدد. من خلال دمج أمر help الفعال الذي يستفيد من تعليقات ##، يمكن للمشاريع توفير وثائق حية ومحدثة باستمرار، مما يقلل الاعتماد على الوثائق الخارجية ويضمن اتساق سير العمل. هذه المنهجية لا تزيد من كفاءة الفريق فحسب، بل تساهم أيضاً في بناء ثقافة تطوير أكثر استقلالية وإنتاجية.