openSUSE / obs-docu

Official Open Build Service Documentation. Content gets reviewed and edited. Generated books are available at http://www.openbuildservice.org
34 stars 70 forks source link

Document placeholder variables for SCM/CI Integration #252

Closed dmarcoux closed 1 year ago

dmarcoux commented 1 year ago

To test this locally:

  1. Pull the changes from this PR, then run daps2docker .
  2. Open the generated user guide in your favorite browser: firefox /tmp/daps2docker-SXo2tVAc/obs-user-guide/html/book.obs-user/cha.obs.scm_ci_workflow_integration.html (the string after daps2-docker- will be different).

Preview of the changes: documentation

DO NOT MERGE: Wait for https://github.com/openSUSE/open-build-service/pull/13498 to be merged and deployed.

dmarcoux commented 1 year ago

Support placeholder variables in workflows file (M)

tomschr commented 1 year ago

Thanks for your contribution. :+1:

Just one friendly remark regarding this pull requests. I know it's tempting to add TODOs as reminder. However, I would recommend NOT to add them. This gives us a bad reputation and let our readers think the documentation is just "draft". TODOs are for the writer, not for the reader.

However, if you really want to leave some notes in your document which shouldn't be visible to our readers you have two options:

Thank you! :slightly_smiling_face:

dmarcoux commented 1 year ago

This PR is a draft and I'm not going to keep the TODOs in the PR whenever I mark it as "ready for review" :slightly_smiling_face:

krauselukas commented 1 year ago

PR is ready for review now, since the functionality is merged and deployed on the OBS side