Fixes for github deploy #1774
Fixes for github deploy #1774
Conversation
This addresses some long-standing comments in #1458 (comment) We should also adopt Gatsby, create-react-app, or something similar designed for static sites, to eliminate the unnecessary runtime dependency on Next.js while also letting someone else maintain our front-end tooling. :-D These tools might work just fine in subdirectories without config, and we might be able to leave Jekyll turned on (though we don’t need it). However these git-related changes are orthogonal. - Don’t check out master, making it possible to deploy the currently checked-out commit - Disable Jekyll which we don’t need. This allows _next folders to be deployed, and the related URL rewriting to be removed. - Set NEXT_ASSET_PREFIX so the site works at both shields.io and badges.github.io/shields - Completely empty the deploy branch’s index before deployment. This prevents errors from broken symlinks, while preserving the commit history in the deploy branch. - Do the deployment work in a git working tree. This requires Git 2.18 but makes it possible to do the above very safely.
Generated by 🚫 dangerJS |
paulmelnikow
added
the
operations
|
Would like to get this addressed for #1783. Could I entreat a review? |
|
I'll give it a go, not sure how well this pc will handle it though. |
|
Thanks! Just reading it would be okay. If you do decide to run it, please do that on a fork so it doesn’t deploy something in the process. |
Makefile
Outdated
| @@ -7,7 +7,7 @@ all: website favicon test | |||
| favicon: | |||
| node lib/badge-cli.js '' '' '#bada55' .png > favicon.png | |||
There was a problem hiding this comment.
Is it just me, or does this no longer produce anything?
Also without the .png it produces this for me:
I presume it's supposed to make this though:
https://img.shields.io/:--bada55.png?style=plastic
There was a problem hiding this comment.
Huh, weird. node lib/badge-cli.js '' '' '#bada55' > favicon.svg produces the right svg for me. No quotes… wonder if that could be a windows thing? Is it better if '' '' is replaced with "" "" in the makefile?
However the png is not working for me either. It makes a valid PNG but it's all gray. I upgraded imagemagick, and it changed to a different gray (!) but still isn't working correctly.
There was a problem hiding this comment.
Opened a new issue: #1788. Going to just back out the favicon updating for now, since we still have a working one checked in.
| git -C ${DEPLOY_TEMP} commit -m '[DEPLOY] Completely clean the index' | ||
| cp -r build/* ${DEPLOY_TEMP} | ||
| cp favicon.png ${DEPLOY_TEMP} | ||
| echo shields.io > ${DEPLOY_TEMP}/CNAME |
There was a problem hiding this comment.
@paulmelnikow The point of the CNAME file was to have GitHub redirect from badges.github.io/shields to shields.io.
I believe it no longer needs that, as it is now set up through the project settings: https://help.github.com/articles/adding-or-removing-a-custom-domain-for-your-github-pages-site/
There was a problem hiding this comment.
Something in my testing suggested the file still has an effect. When I ran this script on my fork without the CNAME file in gh-pages, it turned off the custom domain.
This link suggests changes made in the UI are stored in the repo: https://help.github.com/articles/troubleshooting-custom-domains/#github-repository-setup-errors
This addresses some long-standing comments in #1458 (comment)
We should also adopt Gatsby, create-react-app, or something similar designed for static sites, to eliminate the unnecessary runtime dependency on Next.js while also letting someone else maintain our front-end tooling. :-D These alternative tools might work just fine in subdirectories without config, and we might be able to leave Jekyll turned on (though we don’t need it). However these git-related changes are orthogonal.
Set NEXT_ASSET_PREFIX so the site works at both shields.io and badges.github.io/shieldsCloses #1784