publish docs automatically

redhat-cop / automation-good-practices

Recommended practices for all elements of automation using Ansible, starting with collections and roles, continuing with playbooks, inventories and plug-ins... These good practices are planned to be used by all Red Hat teams interested but can of course be used by others.

268 stars 66 forks source link

publish docs automatically #81

Closed jeichler closed 1 year ago

jeichler commented 1 year ago

currently the docs are fairly behind the current main branch. Ideally docs are published after a merge into the main branch (kinda like version "latest").

thoughts?

djdanielsson commented 1 year ago

I agree, it should be on commit it re-publishes them

ericzolf commented 1 year ago

My initial idea was to push regularly versions, which would trigger the build, but I agree that it doesn't really work well and was probably over-engineered.

ericzolf commented 1 year ago

I just pushed v2022-12-15-12 so we're up-to-date again, but still agreed that we don't need the overhead.

ericzolf commented 1 year ago

IMHO, what needs to be done:

[ ] update the pipeline to re-create the website on merged PRs resp. modified main branch
[ ] add a variable/placeholder in the documentation and some code to automatically do versioning based on Git commit date (like CER does)

Fale commented 1 year ago

@ericzolf what do you mean by "CER" in this context?