Create Github Action to update Ockam Command Manual

[mrinalwadhwa]

Current

Command Manual lives here
https://github.com/build-trust/ockam-documentation/tree/command

And it can be generated using this shell script
https://github.com/build-trust/ockam-documentation/blob/command/manual/template/mdbook/build.sh

Once generated it gets published here
https://command.ockam.io/manual/

Currently all of this done manually

Desired

A github actions workflow that would trigger as part of our release pipeline and result in creating a pull request to the ockam-documentation repo

---

We love helping new contributors! ❤️
If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.

[andrewpollack]

Happy to take a crack at this! I've always wanted to learn github actions, and helping keeping docs up to date is an awesome way to do so 😸

[mrinalwadhwa]

@andrewpollack thank you!! for spending time on it.
Let us know if have any questions along the way.

[andrewpollack]

Thank you @mrinalwadhwa! I wanted to get your thoughts on best practices for a potential cross-repo workflow. I'm thinking of:

• Creating a new workflow in the ockam-documentation, calling to its build.sh with the desired input version and creating a PR with the result.
• Following this post, triggering the above action between the ockam "Generate Changelogs" and "Push Update" actions here via a curl.

Does this seem like the correct approach? If so, is there an access token I can depend on between the two repositories?

[EliKalter]

I am interested in collaborating with someone on their project so I can learn the language while they get a sidekick.
Let me Know if this is something that could work for you.
I Would need you to explain and guide me through my first steps in the language (I already started learning) and set the standard for me in code reviews but after a short while I'm sure I'll become an asset to the project.
(I have some experience in Typescript and Java and have learned C a few years ago).

[andrewpollack]

@mrinalwadhwa Are you able to give any feedback on #4650 (comment) ? Thank you!

[mrinalwadhwa]

@andrewpollack ah I seem to have completely missed your comment. Sorry about that.

Creating a new workflow in the ockam-documentation, calling to its build.sh with the desired input version and creating a PR with the result.

This makes sense 👍
This work I think should create a pull request. Similar to this workflow here
https://github.com/build-trust/ockam/blob/011cb9c955473a693791d3c1d49ccd9cba39ac7d/.github/workflows/create-release-pull-request.yml

Following this post, triggering the above action between the ockam "Generate Changelogs" and "Push Update" actions here via a curl.

Repository Dispatch triggers across repos are hard to execute safely/securely. We've instead, in similar situations, preferred to execute workflow dispatch from commands run on dev machines. There are some examples to do this in our release scripts here, for example:

ockam/tools/scripts/release/release.sh

Line 155 in 011cb9c

gh workflow run create-release-pull-request.yml --ref main -F binaries="$file_and_sha" -F branch_name="$release_name" -F tag="$tag" -R $owner/homebrew-ockam

So, as a start, create the workflow. Let's land that PR and then as part of our release shell script we can invoke the workflow. @metaclips may have advice on where in the release script we could add a trigger to create a pull request that would update the manual.

Thank you for spending time on this issue. Sorry again for missing your questions earlier.

[nazmulidris]

@andrewpollack Thank you for taking the time to look at this issue. Since you’ve not had a chance we’re opening the issue up for other contributors.

[petersooley]

I'd like to help. I'll make a GH workflow on the ockam-documentation repo hat runs the build.sh script and creates a branch with the updated documentation.

[nazmulidris]

@petersooley That's awesome, this is all yours. Please let us know if you have any questions as you explore. You can also ask questions on the contributors discord https://discord.gg/RAbjRr3kds

Also, please associate your PR and issue using this technique: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

[PsychoPunkSage]

Hi @mrinalwadhwa
Is this issue still open??
If no one is working on it. I would like to take it up.... (I am currently working on #8266 , I think it would be nice practice for me to work on another workflows issue)

[PsychoPunkSage]

Hi @mrinalwadhwa I tried to solve this issue. Can you please have a look at it?