A continuación, presentamos la mejor manera para crear un archivo Makefile autodocumentado, con la que se puede sacar un buen provecho y mejorar las cargas de trabajo.
Es una buena forma de preparar repositorios de flujo de trabajo de alias de comandos con pre-proyectos que se pueden registrar.
¿Puede un documento Makefile mejorar los DevOps y satisfacer el trabajo de los desarrolladores? ¿Qué tan bueno sería si un desarrollador que trabaja en su proyecto no comenzara copiando y pegando comandos de su archivo README?
Si en lugar de escribir esto:
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
Pudiera escribir: make start y empezar a trabajar, esto sería una muy buena ventaja.
La diferencia
Se puede utilizar make todos los días para eliminar el tedio de las actividades de desarrollo comunes, como es el hecho de actualizar programas, instalar dependencias y probar.
Para simplificar el trabajo con un archivo Makefile (marca GNU), se deben usar reglas y recetas de Makefile. Existen grandes similitudes con la marca de sabor POSIX, como las reglas de destino
Sin embargo, hay muchas cosas que se pueden hacer con make, a continuación, enumeramos algunas de estas:
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 server
Ahora tenemos algunos alias de línea de comandos que se puede registrar, lo cual se traduce en una gran idea. Si hay preguntas sobre la sintaxis de comentarios, esto puede responder aún mejor.
Makefile autodocumentado
Los alias son muy buenos si se recuerda qué son y qué hacen sin tener que escribir constantemente cat Makefile, por lo que se necesita un comando help:
.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}’
Con el poder de la línea de comandos, el comando egrep toma la salida de MAKEFILE_LIST, la ordena y la usa awk para encontrar cadenas que sigan el ##patrón. A continuación, se puede imprimir una versión formateada de los comentarios.
A continuación se debe poner en la parte superior del archivo para que sea el destino predeterminado. Ahora, para ver todos los atajos y lo que hacen, simplemente hay que ejecutar make, o 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
Ahora tenemos una herramienta CLI personalizada y específica para cada proyecto
Son muchas las posibilidades de mejorar el flujo de DevOps con un Makefile autodocumentado. Esto se puede usar para simplificar cualquier flujo de trabajo y para darle más tiempo de calidad a los desarrolladores.
Leíste: La mejor manera para crear un archivo Makefile autodocumentado, te recomendamos: Aspectos clave para desarrolladores que quieren codificar
Te invitamos a que nos sigas en nuestras redes sociales: Facebook, Twitter, Instagram y Youtube con el perfil: @tortugacode
