Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc fetch actions #1690

Merged
merged 2 commits into from
Dec 8, 2021
Merged

Conversation

Confectrician
Copy link
Contributor

This will add a reusable action base for fetching external docs contents.

Goal

Provide updated "stable" docs for parts of openHAB, that have their own indipendent release cycle.

Workflow

Reusable template action

The introduced reusable action is meant to be called from other repo based actions.
It will check for matching files based on a given configuration and remove the current existing doc files.
After that it will copy the newest available version from the external repository.

Detailled repository action

A detailed action can be added per external repository.
This action simply calls the reuseable action with a repository specific configuration.
As a proof of concept the first repository based action comes with this pr and enables this workflow for the openhab/openhabian repository.

External trigger events

The detailled repository action is able to get triggered from the external repo through the repository_dispatch event.
This needs a personal access token, with public_repo access for the openhab-docs repository.

The external repo can then actively trigger a docs update. (For example when a new openHABian version is released.)

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
@netlify
Copy link

netlify bot commented Dec 6, 2021

✔️ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

🔨 Explore the source changes: 0438928

🔍 Inspect the deploy log: https://app.netlify.com/sites/openhab-docs-preview/deploys/61b127c8e3a1bf00073daf10

😎 Browse the preview: https://deploy-preview-1690--openhab-docs-preview.netlify.app

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant