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

Docs should get built automatically #29

Open
shardros opened this issue Nov 6, 2021 · 4 comments
Open

Docs should get built automatically #29

shardros opened this issue Nov 6, 2021 · 4 comments
Labels
dependencies Pull requests that update a dependency file enhancement sheep Pull requests which effect code or building of vue components

Comments

@shardros
Copy link
Member

shardros commented Nov 6, 2021

Brief

As a Shepherd patch developer.
I would like the docs to be automatically updated from the website whenever the website changes.
So that

  • I don't have to remember to update them
  • We know that nothing has changed since they were last updated to make them not updatable

Notes

Whenever the docs are changed in the website repo they should trigger some kind of GitHub Action build step which should push an updated version to master of shepherd.

We should be careful about pushing large amounts of binary data to shepherd e.g. images. I already make sure to always clone with --depth 1.

@shardros shardros added enhancement dependencies Pull requests that update a dependency file sheep Pull requests which effect code or building of vue components labels Nov 6, 2021
@casheww
Copy link
Contributor

casheww commented Nov 13, 2021

This requires cloning shepherd, which I don't think is possible from a GitHub Action until shepherd is made public, so I think this is waiting on #30 . Once that's been done and shepherd is public, I'm happy to continue working on this :)

@shardros
Copy link
Member Author

I don't know if this is a good idea to do automatically but we will probally need to make sure that every PR is rebased before merging to master otherwise we might lose changes in the compiled output. In #30 right now
image

@Minion3665
Copy link
Member

This requires cloning shepherd, which I don't think is possible from a GitHub Action until shepherd is made public, so I think this is waiting on #30 . Once that's been done and shepherd is public, I'm happy to continue working on this :)

It would be possible to use secrets to store a PAT (or a deploy key?) and clone using that, but I agree that it would probably be better to fix and merge #30 instead

@shardros
Copy link
Member Author

Now unblocked 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement sheep Pull requests which effect code or building of vue components
Projects
None yet
Development

No branches or pull requests

3 participants