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

Actions workflow for building and updating docs #45

Merged
merged 4 commits into from
Jul 11, 2020
Merged

Conversation

J0B10
Copy link
Member

@J0B10 J0B10 commented Jul 2, 2020

Workflow that automatically updates the docs once files are pushed to master.

Needs to be tested locally using phishy/wflow or nektos/act.

Also the private access tokens for the docs repo must be generated and added as secrets to the repo as ${{ github.token }} only has acces to the nodecg-io repo.

@J0B10 J0B10 self-assigned this Jul 2, 2020
@J0B10 J0B10 linked an issue Jul 2, 2020 that may be closed by this pull request
8 tasks
@J0B10 J0B10 removed a link to an issue Jul 2, 2020
8 tasks
@J0B10 J0B10 added the help wanted Extra attention is needed label Jul 3, 2020
@J0B10
Copy link
Member Author

J0B10 commented Jul 3, 2020

I tried to test it but I couldn't get docker to run on my windows machine as I have Windows 10 Home with update 1906 and docker requires a Pro / Enterprise / Education or Home update 2004 (which unfortunatly isn't available for my device yet).
This is couased by Hyper-V being not supported on these operating systems and WSL2 being not available. For more information on this see Install Docker Desktop on Windows and https://docs.docker.com/docker-for-windows/install-windows-home/

If somebody has docker working and set up and is familliar with github actions I'dd be happy if you could save me a lot of work by testing this.

If nobody is found I'll need to test if I can get this to work on a linux system.

@hlxid
Copy link
Member

hlxid commented Jul 4, 2020

I couldn't get this working with either act or wflow. Both failed at the setup-python action.
From looking at the workflow file the python script should work, but according to the ad-m/github-push-actions Readme we need to manually commit and the action just pushes.

* Added secret containing ssh deploy key
* Reworked push mechanic to work with deploy keys
@J0B10 J0B10 removed the help wanted Extra attention is needed label Jul 10, 2020
@J0B10 J0B10 requested a review from hlxid July 10, 2020 21:07
Copy link
Member

@hlxid hlxid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the two review comments this looks good to me.

.github/workflows/docs.yml Outdated Show resolved Hide resolved
.github/workflows/docs.yml Show resolved Hide resolved
* Fixed typo
* Don't run workflow on fork

Co-authored-by: Daniel Huber <[email protected]>
@J0B10 J0B10 merged commit 8a83746 into master Jul 11, 2020
@hlxid hlxid deleted the docs-actions-workflow branch July 11, 2020 09:35
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 this pull request may close these issues.

2 participants