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

filecoin-project / lotus

Reference implementation of the Filecoin protocol, written in Go

https://lotus.filecoin.io/

Other

2.85k stars 1.27k forks source link

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

Open virajbhartiya opened 2 weeks ago

virajbhartiya commented 2 weeks ago

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 commented 2 weeks ago

@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 commented 2 weeks ago

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

virajbhartiya commented 2 weeks ago

@rvagg any suggestions on why is the workflow failing?

rvagg commented 1 week ago

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:

rename check.yml to check-and-gen.yml
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 commented 1 week ago

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

BigLep commented 11 hours ago

I know there have been verbal conversation on this one. Did we write out the next steps?

rvagg commented 7 hours ago

Didn't write it out, but next steps are to get this completed and merged and then experience it live and decide whether we hate it or love it and whether it's a QoL improvement on balance.