codeforgermany / click_that_hood

A game where users must identify a city's neighborhoods as fast as possible
http://click-that-hood.com
MIT License
450 stars 639 forks source link

Consider switching to github's official workflow action for deploying to `gh-pages` #348

Open specious opened 2 years ago

specious commented 2 years ago

Currently, a push to the main branch triggers a deployment to the gh-pages branch, which subsequently triggers github's built-in publishing of the website to github pages (i.e. free hosting for this app, courtesy of github).

The automated (or manually triggered) deployment to gh-pages currently uses the workflow action JamesIves/github-pages-deploy-action and it works very well (see this run, under build-and-deploy > "Deploy /public to gh-pages branch"). However, github has recently released their own actions/deploy-pages action (currently in public beta) which aims to officially do the same thing.

To clear up any confusion, this is distinctly different from the built-in pages-build-deployment action (see this run), which publishes the latest content on the gh-pages branch to the web so it's available online.

See: "Do I need the pages-build-deployment Github Action, when I have another action for my Github Pages?" on Stack Overflow

Perhaps at some point it makes sense to consider switching from JamesIves/github-pages-deploy-action to the official actions/deploy-pages workflow action for deploying to the latest commit to main to gh-pages.

specious commented 2 years ago

I know these details may seem unnecessarily complex to a lot of people and there is absolutely no urgency to the matter. However, I decided that it makes sense to open this discussion in case anyone is interested.