Find a way to not be forced to store the Antora UI bundle in the repository

[bonitasoft]

Find a way to not be forced to store the Antora UI bundle in the repository

[tbouffard]

Proposal

Principle: share the ui bundle as a github release asset

in the bonita-documentation-theme repository

• Tag version with v1, v2, ...: we do not care to follow semantic versioning here IMHO as we are doing continuous delivery and deployment.
• Add a GH workflow triggered by worfklow_dispatch (manual run) - no need for inputs: it will tag the repository and automatically increment the version
• Add a GH workflow triggered on tag (splitting the tag creation and the post processing on tag lets us rerun the processing in case of issue) that will
  • create and publish a new GH release
  • add the automatically generated release notes by github
  • generate the UI bundle and attach it to the release. Filename should include the tag/version for better tracking, something like bonita-documentation-theme-v12.zip. See https://github.com/bonitasoft/bonita-platform-releases/releases/tag/2022.1-u0 for instance.
  • send a repository_dispatch event targeting the bonita-documentation-site to make it use the new UI bundle

in the bonita-documentation-site repository

Create a GH workflow triggered on the repository_dispatch event (see above)

• the event must contains info allowing to get the UI bundle info: git tag, file name, url to the ui bundle zip, link to the theme release notes
• create a pull request to use the new bundle
  • add a link the release notes in the PR description for review
  • in the antora.yml playbook
    • update the url to the ui bundle: see https://docs.antora.org/antora/3.0/playbook/ui-bundle-url/ for more details, in particular how Antora manages ui bundle cache
    • add a comment to the release notes for review

Document the whole process (with bpmn diagram? something like https://raw.githubusercontent.com/process-analytics/bpmn-visualization-js/v0.23.0/docs/contributors/images/release_process_part-01_release_automation.png)

[tbouffard]

All tasks are completed, issue closed