[TT-1725] add doc generating workflow

[Tofel]

---

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes introduce a new GitHub Actions workflow aimed at automating the generation and review of Go documentation for new pull requests. This ensures that documentation is consistently updated alongside code changes, facilitating better understanding and review of code modifications.

What

• .github/workflows/generate-go-docs.yaml: New GitHub Actions workflow file created.
  • Workflow is triggered by labeled, reopened, and synchronize events on pull requests to ensure documentation is generated on relevant updates.
  • Conditional execution based on the presence of a specific label (generate_go_docs) on the pull request.
  • Runs on the latest Ubuntu runner with specific permissions set for contents reading, pull-requests writing, and repository-projects reading.
  • Steps include:
    • Checking out the current branch with a full fetch depth.
    • Setting up Git with GitHub Actions bot user for commits.
    • Extracting pull request details (number, branch, base commit, head commit) for use in subsequent steps.
    • Installing Go documentation generator tool and gopls.
    • Creating a new branch for documentation changes, based on the pull request branch with a -docs suffix.
    • Generating Go documentation comparing the base and head commits of the pull request.
    • Ensuring the code compiles after documentation generation with go mod tidy, go mod vendor, and go build ./....
    • Committing the generated documentation changes and pushing them to the origin repository.
    • Finally, creating a new pull request targeting the current pull request branch with the generated documentation for review.

[cl-sonarqube-production]

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube