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

Deploy docs via github actions. #81

Open
Levdbas opened this issue Dec 15, 2023 · 1 comment · May be fixed by #82
Open

Deploy docs via github actions. #81

Levdbas opened this issue Dec 15, 2023 · 1 comment · May be fixed by #82

Comments

@Levdbas
Copy link
Member

Levdbas commented Dec 15, 2023

Is your feature request related to a problem? Please describe.

The docs are now deployed ad-hock when the need occurs. Ideally you would deploy the docs after every change in the /docs/ directory of the Timber main repo.

Describe the solution you’d like

Create a github action that does the following:

  • Checkout timber/timber in a directory
  • Checkout timber/docs in another directory
  • Run the build process
  • Deploys the artifacts of that build to Github pages.

At first this could be a manual trigger from the docs repo but we could automate that even further so that the action is triggered when in the main timber branch a commit is merged that changes the docs.

If this all works we could delete the content, docs and build folder from the repo since these are artifacts anyway.

@Levdbas Levdbas linked a pull request Dec 15, 2023 that will close this issue
@Levdbas Levdbas linked a pull request Dec 15, 2023 that will close this issue
@nlemoine
Copy link
Member

nlemoine commented Jan 4, 2024

Ideally you would deploy the docs after every change in the /docs/ directory of the Timber main repo.

Not only. Because PHP file changes would also trigger API reference changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants