sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-24 00:47:57 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/.github/workflows/pr_to_doc_issue.md
Denis Rouzaud c91a133bd7 complete README
2020-01-10 16:18:29 +01:00

1.2 KiB
Raw Blame History

How to use it

  1. Create a PR
  2. Tag it with "Needs Documentation"
  3. Optionally set the milestone to it
  4. Merge it

Then

  • a message will be added to PR to ping the author about her/his responsibility to handle the documentation issue
  • an issue is automatically created in the QGIS-Documentation repository when the PR gets merged

Example:

How it works

  • A Github workflow takes care of creating the issue and commenting.
  • To make it works on jobs triggered from forks (almost all PRs actually), the Github token has to be manually given. Since it cannot be written in clear, an action obfuscates its using xor encryption.
  • The labels on QGIS-Documentation are deduced from the PR milestone (e.g. 3.10.2 => 3.10). To label issues, push access is required. Due to security reasons (the token appears in clear), qgis-bot has no specific rights. Labels are created using a workflow.