feat(docs): add workflow to generate documentation on PR merge

[virajbhartiya]

Related Issues

Closes #12233

Proposed Changes

Add a workflow that run make docsgen-cli whenever the PR is merged

Checklist

• Commits have a clear commit message.
• PR title conforms with contribution conventions
• Update CHANGELOG.md or signal that this change does not need it per contribution conventions
• New features have usage guidelines and / or documentation updates in
  • Lotus Documentation
  • Discussion Tutorials
• Tests exist for new functionality or change in behavior
• CI is green

[rvagg]

you should check your editor and remove these auto-fix rules that you have, it's generally not good manners to go editing things unrelated to what you're intending to change without good reason to do so

[masih]

@virajbhartiya Also single quote and double quote have specific meaning in YAML, similar to bash. Here, single quote is appropriate because there are no special characters expected/acceptable in recursive.

[virajbhartiya]

For some reason, my linter was automatically replacing the quotes, fixed it

[rvagg]

@virajbhartiya can you resolve the conflict with master here please? You'll see that your " substitutions are getting in the way, so resolving those would be good.

[virajbhartiya]

Hey @rvagg, I have resolved the conflicts in the PR

[virajbhartiya]

@rvagg any suggestions on why is the workflow failing?

[rvagg]

Failing because you need to install system dependencies for the build

in check.yml, you'll see:

      - uses: ./.github/actions/install-system-dependencies
      - uses: ./.github/actions/install-go
      - uses: ./.github/actions/make-deps

these are required to perform the actions you need, so you'll have to do it again in your new job

but, having said that, it's not cheap, so maybe this should all be in a single job so that's all done once and it's just the docsgen-cli bit that's done separately.

So how about this:

1. rename check.yml to check-and-gen.yml
2. add a docsgen-cli section to it with your new stuff, so that happens in the same flow

I'm still not convinced this is a great idea, it might get in the way. So we'll need to have a collective chat with others before we proceed.

[virajbhartiya]

Hey @rvagg thanks for the review, I have currently modified it accordingly, renamed check.yml to check-and-gen.yml and added it in the same file. We can discuss regarding this on slack wtih other how to go ahead with this PR