Closed BryanQuigley closed 1 year ago
Looking good! And I agree, it's great that we can let go of the github-pages plugin. The only thing is that that plugin also bundles in a variety of other plugins, so we'll want to review those and consider whether anyone may be depending on them (if so, this would be a breaking change for them as they'd have to explicitly declare that dependency or their build will break). The easy way around that is to simply bundle those plugins in JKAN as well (until the next breaking-change version).
Here's the list of plugins. I think it's just the first set at the top we'd need to worry about, as I presume the list after that still need to be explicitly declared when using the github-pages gem.
The only other thing is that pesky "Edit on GitHub" link, which ideally wouldn't be statically bound to the main
branch. It's driving me mad trying to figure out why that isn't working properly... I notice that, even without this PR, those links still point to gh-pages
in my local development environment for some reason, even though we've changed the default branch. I reckon it's fine to merge without that fix since it's broken to begin with, but we should create an issue for it if we don't fix it before merging this.
I just ran into what I believe to be an example of the above dependency issue (though I could be wrong - I was testing with Jekyll 3.9). I assume this is pulled in by one of those plugins 🤔
Interesting: I've been investigating the branch issue a bit further, and it appears it may be an issue with the GitHub API, itself.
GET https://api.github.com/repos/timwis/jkan/pages
(api docs)
returns:
{
"url": "https://api.github.com/repos/timwis/jkan/pages",
"status": "built",
"cname": null,
"custom_404": false,
"html_url": "http://timwis.com/jkan/",
"build_type": "workflow",
"source": {
"branch": "gh-pages",
"path": "/"
},
"public": true,
"protected_domain_state": null,
"pending_domain_unverified_at": null,
"https_certificate": {
"state": "approved",
"description": "The certificate has been approved.",
"domains": [
null,
"www.timwis.com"
],
"expires_at": "2023-07-05"
},
"https_enforced": false
}
Running it against azavea/opendataphilly-jkan
says the source.branch is v2
.
This is the value that the github-pages gem is using to construct the edit link.
The GitHub edit link changing has been annoying me to no end, thank you for chasing it down and figuring out where it actually was coming from!
I was hoping it would be simple to just include them, but just checking one https://github.com/github/jekyll-commonmark-ghpages/issues/22 determined it won't be an obvious 1:1 matching..
As for your kramdown-parser-gfm error, that is included in the lock file by default, if you were trying to run it on Jekyll 3.9 I don't think it will work.
Also updated bundler and ruby versions in Docker.
Had to go through several iterations to get GitHub-metadata to work, as part of that:
With the switch to GitHub actions/Netlify I don't see any blockers to the upgrade.