Fix variable reference

[kequach]

Variable reference apparently changed from GITHUB_TOKEN to TOKEN.

[kequach]

Hmm, this still doesn't work even with the correct variable reference due to repository policies:

I see 3 options here:

1. We fix the pipeline to work with new policy settings
2. We change the policy settings
3. We remove the gh-pages

[J535D165]

Thanks for pointing out option 3. The GitHub landing page has improved over the last year and is now easier to read for non-coders. Personally, I'm never using the website.

[jelletreep]

Would be fine with option 3.

To fix it, i think you now have to give the token permission to write:

permissions:
  contents: write

https://github.com/JamesIves/github-pages-deploy-action

It is also possible to store the website as artifact (instead of using the gh-pages branch):
https://github.com/actions/deploy-pages
In this case you would have to change the repository settings for github pages.

Happy to update the workflow if we don't go for option 3

[kequach]

I personally find option 3 sufficient. The readme is totally fine. The main benefit the website had was the additional ToC to navigate, but as Jonathan pointed out, the READMEs on Github improved a lot. You can now navigate in the Readme too:

if you are also fine with that, I'll just remove the website

[jelletreep]

Yes, I am totally fine with removing the website!

[kequach]

I removed the relevant stuff, should be good to merge

[jelletreep]

Thanks @kequach for updating the PR!

[jelletreep]

Is this workflow meant to sort and update the README.md if it is not properly sorted? If so, then I think we should add a commit action to commit the result

[kequach]

@jelletreep good point, I think the commit/push was implicit with the deployment of the page. Haven't thought about that

[J535D165]

Thanks!