enonic / release-tools

Enonic Release Tools
2 stars 0 forks source link

Migrate docs gen to GH Actions #53

Closed rymsha closed 1 year ago

rymsha commented 1 year ago
rymsha commented 1 year ago

Procedure

  1. Delete Webhook in the repository (it is in Settings/Webhooks)

  2. Cleanup gradle build. It may be for pure asciidoc verification, in this case delete

build.gradle
gradlew
gradlew.bat
gradle/
settings.gradle
verbose-mode.rb

In other repositories gradle builds a demo app. in this case remove asciidoctor/htmlSanityCheck plugins and config from build.gradle

  1. Configure Github Action "Enonic Documentation". It can be done with a help of "new Workflow" button in GitHub. You may need to adjust on.push.branches config in the resulting file to specify branches that trigger docs rebuild

  2. Sometimes README.md contains info about asciidoc gradle build - remove it

  3. Trigger "Generate Documentation" manually. verify it works (modification date changed )

  4. Mark repository as done in this issue