Introduce workflow for doc

[sunglim]

Is your feature request related to a problem? Please describe.
As we're updating docs manually, docs can be easily outdated.

Describe the solution you'd like
Introduce a github workflow for docs. I think there is two options.
option#1. When PR is created, a workflow is triggered, if doc in the PR is not updated, the bot will fail.
option#2. When a new PR is merged, a workflow is triggered to create a PR with doc updated.

Describe alternatives you've considered
N/A

Additional context
Discussed in #171 (comment)

[cinar]

I wonder, given that the repo requires signed commits, would it be better to handle this as part of the Git pre-commit hook? This will ensure that it gets executed before it leaves the contributor's machine. It is also easy to have it invoke the existing ./pre-commit.sh. what do you think?

[sunglim]

Thank you for asking my opinion.

Yes. I agree that Git pre-commit hook is a good(better for now) solution.

This will ensure that it gets executed before it leaves the contributor's machine.

I have a small concern. Contributors can intentionally or unintentionally skip pre-commit hook installation. So, it's not 100% guaranteed. I think later on when this repository becomes more popular, we can visit this thread again and consider using workflow.

Please feel free to close this issue.

[cinar]

You gave a great point. I wonder if we need to combine both. Git hook to do it with the commit, and a GitHub workflow to perhaps block the pull request?

[sunglim]

My two cents is

Ideally, we need to use both. Run pre-commit to executes locally & quickly before committing. Then workflow is triggered when a PR is created, it will block if doc is not updated.

I ran sh pre-commit.sh on my mac. it takes 20s. If we introduce git pre-commit hook, I think we should reduce the running time. Otherwise, it will be annoying as it is called every commits.

$ time sh pre-commit.sh
/Users/i333043/go/bin/revive
...
real	0m20.206s
user	0m9.189s
sys	0m9.714s

PS.
To be honest, my preference is having only github workflow to block PR. It is a simple.

[cinar]

To be honest, my preference is having only github workflow to block PR. It is a simple.

Let's do it. I agree with you that it is simpler. We can always do the Git hook when necessary.

Thank you so much again for your contribution!