Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Use actions/github-pages to publish docs#133

Draft
garryod wants to merge 3 commits intomainfrom
use-github-pages-action
Draft

Use actions/github-pages to publish docs#133
garryod wants to merge 3 commits intomainfrom
use-github-pages-action

Conversation

@garryod
Copy link
Copy Markdown
Contributor

@garryod garryod commented May 3, 2023

Uses the official actions/github-pages action to publish docs to GitHub Pages. This should remove the need for gh-pages branch

@garryod garryod added enhancement New feature or request github_actions Pull requests that update GitHub Actions code labels May 3, 2023
@garryod garryod requested review from coretl and gilesknap May 3, 2023 14:40
@garryod garryod self-assigned this May 3, 2023
@garryod garryod marked this pull request as draft May 3, 2023 14:45
@codecov
Copy link
Copy Markdown

codecov bot commented May 3, 2023

Codecov Report

Merging #133 (796150e) into main (64d2a03) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #133   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           16        16           
=========================================
  Hits            16        16           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@garryod garryod temporarily deployed to github-pages May 3, 2023 14:57 — with GitHub Actions Inactive
@gilesknap
Copy link
Copy Markdown
Contributor

gilesknap commented May 4, 2023

At present this does not fit with the skeleton documentation model.

Skeleton keeps track of multiple versions of documentation and has a Docs Cleanup job to remove documentation on deleted branches. This all works vis the gh-pages branch that is not used by actions/github-pages. In future we could support the same features with actions/github-pages by fetching and mutating the documentation artifact. For now we will continue to use peaceiris/actions-gh-pages, in future this approach may be deprecated - review at this point.

@coretl
Copy link
Copy Markdown
Contributor

coretl commented May 15, 2023

Also, this PR broke the existing gh-pages deployment, I had to "unpublish", then change the gh-pages root and put it back to restore it.

@garryod
Copy link
Copy Markdown
Contributor Author

garryod commented May 16, 2023

Also, this PR broke the existing gh-pages deployment, I had to "unpublish", then change the gh-pages root and put it back to restore it.

Oops, sorry about that. Presumably the work of actions/configure-pages

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancement New feature or request github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants