junit5 icon indicating copy to clipboard operation
junit5 copied to clipboard

Published 20 hours ago • verified publisher icon junit-team

Use actions/deploy-pages for deployment to GitHub Pages

Open vlsi opened this issue 6 months ago • 5 comments

Currently, JUnit documentation publishes to a gh-pages branch which creates wasteful commits in git history, it consumes space for those who clone the repository.

It would be great to drop gh-pages branch altogether.

What do you think of using actions/deploy-pages instead so the contents deploy to Pages without being comitted to git?

See:

  • https://github.com/actions/deploy-pages
  • https://gohugo.io/host-and-deploy/host-on-github-pages/#step-7

vlsi avatar May 29 '25 09:05 vlsi

Currently, JUnit documentation publishes to a gh-pages branch which creates wasteful commits in git history, it consumes space for those who clone the repository.

It would be great to drop gh-pages branch altogether.

I wholeheartedly agree. 👍

What do you think of using actions/deploy-pages instead so the contents deploy to Pages without being comitted to git?

I wasn't aware of this alternative deployment mechanism. Thanks for bringing it to our attention!

IIUC using actions/deploy-pages requires uploading an artifact that contains all resources via actions/upload-pages-artifact in a previous step. Since we deploy only the docs for one version but would like to keep the docs for older versions available, how would that work?

marcphilipp avatar May 29 '25 11:05 marcphilipp

Looks like partial deployments are not planned: https://github.com/actions/deploy-pages/issues/73#issuecomment-1477234353

The way out is to build the full site and publish it as a single unit.

vlsi avatar May 29 '25 11:05 vlsi

So we'd have to store it in some place (let's say a Git repo), add the new content, and publish it from there. Sounds a lot like the existing approach… 🙃

marcphilipp avatar May 29 '25 15:05 marcphilipp

An alternative would be to deploy the junit5 subdirectory as part of https://github.com/junit-team/junit-team.github.io

marcphilipp avatar Jun 01 '25 12:06 marcphilipp

If you would like us to be able to process this issue, please provide the requested information. If the information is not provided within the next 3 weeks, we will be unable to proceed and this issue will be closed.

github-actions[bot] avatar Jun 16 '25 02:06 github-actions[bot]

Superseded by:

  • #4663
  • #4664

marcphilipp avatar Jun 20 '25 09:06 marcphilipp