[DOC] Publish HTML documentation preview on surge

[tbouffard]

When documentation source files change, publish the generated documentation to surge to easy the review.
Create a workflow that will later include a job to publish to gh-pages.
The HTML documentation content is not customized nor updated. This will be done later.

refs #19
refs #40 (HTML documentation improvements)
closes #125

Completed tasks

documentation generation

• setup pkgdown
• search: to test locally, use a webserver (local browsing generates CORS error when using the search bar)

GH workflow

• setup a workflow to deploy PR preview to surge as we do in other repositories
• surge deploy
• introduce a shared action to avoid duplication between the doc and build workflows

Notes

In the 1st commits of this PR, there was an attempt to have a job to build the documentation and others to deploy.
The build documentation job would be skipped . I tried to use a condition to skip it for surge teardown, but in this case the dependent job doing the surge teardown wasn't called.
The issue seems coming from actions/runner#491

The surge teardown is configured but it is not effective. See #128 (comment)
This is not a blocker: a schedule task teardowns stale deployments on regular basis, so even if the deployment is not remove when the PR is closed, this will be done few days later.

[tbouffard]

Closing to test the surge teardown

[tbouffard]

⚠️ Current surge deploy error. This is an issue due to the environment, it works on the playground repository

(node:1654) UnhandledPromiseRejectionWarning: ReferenceError: Cannot access 'buildingLogUrl' before initialization
    at fail (/home/runner/work/_actions/afc163/surge-preview/v1/webpack:/surge-preview/lib/main.js:100:1)
    at /home/runner/work/_actions/afc163/surge-preview/v1/webpack:/surge-preview/lib/main.js:211:1
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
(node:1654) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:1654) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

The error occurs both when the surge preview is called in the same job of the documentation is built or when it is in a dedicated job.

[tbouffard]

Retesting the surge teardown, closing the PR temporary.
❌ Still KO. The issue comes from bonitasoft/actions/packages/surge-preview-tools@v2

The actual domain is using lower case, whereas the domain name checked for existence contains upper case parts (the name of the repository, in our case bpmn-visualization-R). As the check for existence is case sensitive, the action always detect that the domain doesn't exist

Number of domains: 14
##[debug]["process-analytics-github-actions-playground-demo_preview-pr-174.surge.sh","process-analytics-github-actions-playground-demo_preview-pr-175.surge.sh","process-analytics-github-actions-playground-demo_preview-pr-173.surge.sh","process-analytics-bpmn-visualization-r-pr_preview-pr-128.surge.sh","process-analytics-bpmn-visualization-r-demo_preview-pr-128.surge.sh","process-analytics-bpmn-visualization-js-demo_preview-pr-2353.surge.sh","process-analytics-bpmn-visualization-js-doc_preview-pr-2353.surge.sh","process-analytics-process-analytics-dev-site_preview-pr-738.surge.sh","process-analytics-bpmn-visualization-js-demo_preview-pr-2342.surge.sh","process-analytics-bpmn-visualization-js-doc_preview-pr-2342.surge.sh","process-analytics-process-analytics-dev-site_preview-pr-718.surge.sh","process-analytics-icpm-demo-2022-demo_preview-pr-80.surge.sh","process-analytics-bpmn-visualization-js-demo_preview-pr-2323.surge.sh","process-analytics-bpmn-visualization-js-doc_preview-pr-2323.surge.sh"]
::endgroup::
Checking if surge domain exist. Domain: process-analytics-bpmn-visualization-R-pr_preview-pr-128.surge.sh

Detailed logs:

• attempt 1: https://github.com/process-analytics/bpmn-visualization-R/actions/runs/3516899989/jobs/5894038608
• attempt 2 in debug: https://github.com/process-analytics/bpmn-visualization-R/actions/runs/3516899989/jobs/5894067606
• logs of the attempt 2: logs_209.zip