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

Updates workflows to build & test Docusaurs. Closes #4754 #4789

Closed
wants to merge 1 commit into from

Conversation

Jwaegebaert
Copy link
Contributor

Closes #4754

@Jwaegebaert Jwaegebaert force-pushed the docs/workflows branch 2 times, most recently from 770b64d to 56b2cd0 Compare April 22, 2023 16:29
.github/workflows/check_pr.yml Outdated Show resolved Hide resolved
.github/workflows/check_pr.yml Outdated Show resolved Hide resolved
working-directory: docs

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Copy link
Member

Choose a reason for hiding this comment

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

Is there no github-owned package for publishing pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Didn't find anything simular directly. Docusaurus suggests to work with this popular third-party deployment action

https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

@Jwaegebaert Jwaegebaert Apr 23, 2023

Choose a reason for hiding this comment

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

Nice find. That appears to work as well 😄

https://github.com/Jwaegebaert/cli-build-test/actions/runs/4779137491

Although it looks like it doesn't create a commit to the branch gh-pages. Is that common behavior for GitHub action deploys to pages?

Copy link
Member

Choose a reason for hiding this comment

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

Good question. Let's find out

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Instead of deploying the build to a separate branch, they do a deployment to a GitHub Environement. https://github.com/Jwaegebaert/cli-build-test/deployments

Copy link
Member

Choose a reason for hiding this comment

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

Just to clarify: that's sufficient for our purposes, right? I can see the docs on your repo just fine (excl. the mismatched URL but that's deliberate) but not sure if that's from a previous deployment or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That should be sufficient enough. My docs is just because of the quick setup 😅

.github/workflows/release_next.yml Outdated Show resolved Hide resolved
@Jwaegebaert Jwaegebaert marked this pull request as draft April 23, 2023 12:18
@Jwaegebaert Jwaegebaert marked this pull request as ready for review April 23, 2023 18:52
@milanholemans
Copy link
Contributor

@waldekmastykarz can I assign this one to you since you already did a review? Also I think you are more experienced with GH pipelines than I am 😄

@waldekmastykarz waldekmastykarz marked this pull request as draft May 9, 2023 17:24
@milanholemans milanholemans force-pushed the docs-migration branch 2 times, most recently from 0ccf65e to b5b7244 Compare May 16, 2023 18:54
@Jwaegebaert Jwaegebaert marked this pull request as ready for review May 17, 2023 12:50
@Jwaegebaert Jwaegebaert deleted the docs/workflows branch June 25, 2023 20:56
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.

Docusaurs: Modify GitHub actions to build & test
3 participants