search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

WIP: Add a preview-build action for PRs #227

Open mjahoda opened 7 months ago

mjahoda commented 7 months ago

An attempt to add an automatically triggered action that provides a preview build for every new or re-opened pull request.

mjahoda commented 6 months ago

@rolfedh @IanFrangs @emmurphy1 Thank you for checking the PR, but it is far from to be finished. I tried to indicate this by WIP: in the title. Because it's based on the YAML file [1] we use for publishing our main deliverable, we can use Rolfe's suggestions also there.

I'm still struggling to realize what URL can I use for deploying preview builds. In the Github docs for deploying PR preview I've checked, I only found url: ${{ steps.deployment.outputs.page_url }} we already use for the latest published mod-docs guide.

After the upcoming RHEL Beta releases are out, I'll try to follow guidance on [2]. And probably on some copy of this repository first.

[1] https://github.com/redhat-documentation/modular-docs/blob/main/.github/workflows/deploy-site.yml

[2] https://medium.com/@vegaobed/how-to-enable-pull-request-previews-in-github-pages-dc3a94fa969b