search

leostera / caramel

:candy: a functional language for building type-safe, scalable, and maintainable applications
https://caramel.run
Apache License 2.0
1.06k stars 25 forks source link

Add docs Github Actions workflow #48

Closed michallepicki closed 3 years ago

michallepicki commented 3 years ago

This new docs workflow automates the process of regenerating the manual/src files into the docs/manual output, and pushes the whole docs directory to a separate gh-pages branch.

You can see the workflow run at https://github.com/michallepicki/caramel-mdbook-automated/runs/1764689663 and preview the deployed result at ~https://michallepicki.github.io/caramel-mdbook-automated/manual/~ (it's possible that some links are broken because in my fork the manual is deployed to a doubly nested directory, so if some are then I wouldn't worry about that. I see that the website index page renders without styles / broken because of that.).

After this gets deployed, and Github Pages source is reconfigured, it's possible that a workflow re-run (or new push to main) will be needed to get the website deployed from the new source.

Closes #47

michallepicki commented 3 years ago

  1. Should I remove the current docs/manual contents in this PR and add it to .gitignore?

  2. Should I update manual/src/contrib/manual.md with replacing the following section with something else?

    Commit that entire folder before you open a Pull Request.

leostera commented 3 years ago

@michallepicki this looks great! 🙌🏼 I'll merge as is and we can update the manual in a PR to give it a run.

leostera commented 3 years ago

Worked like a charm 👌🏼

Commit: https://github.com/AbstractMachinesLab/caramel/commit/e275b0ce5707433b054f7b1879bc1681b4eed924

https://caramel.run/manual/contrib/manual.html