Skip to content

Make commands from devops folder are missing on docs page /reference-guide/cookieplone-make-commands.html #1988

@acsr

Description

@acsr

Issue

There is no reference docs for the devops folder make commands in this documentation page

  • The ./devops/Makefile is generated by the Cookieplone template option to for deployment boilerplate.

  • cookieplone Project generation [1] options:

    • [17/19] Add Ansible playbooks?
    • [18/19] Add GitHub Action to Deploy this project?
  • The original help text generation of the genarated Makefile was broken. (PR provided)

  • There is some hands on Information in the README files, but no reference docs.

TODO

Add at least

  • Add the (working) current output of the make help command. I documented this in the fix for the help command in Fix broken devops Makefile help generation expression cookieplone-templates#305.

  • Describe how to invoke make help command in your own devops setup, to get the help related to your setup (subject to change)

  • Add a reference to the Readme files generated by Cookieplone in the devops folder and deployment trainings referring to these commands. This avoids doubling the detailled documentation.

  • ./devops/README.md

and

  • ./devops/README-GHA.md
  • ./devops/README-GITLAB.md

Currently I cannot provide a polished Pull Request myself due to overload.
Should be an easy task with the linked ticket #305 as foundation.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions