search

zk-org / zk

A plain text note-taking assistant
https://zk-org.github.io/zk/
GNU General Public License v3.0
1.67k stars 124 forks source link

gh-pages build on push, not release #430

Closed tjex closed 2 months ago

tjex commented 2 months ago

The gh pages fix from https://github.com/zk-org/zk/pull/387 setup deployment / build to occur on release publishing.

The documentation / readme is therefore stuck until the next zk semver release.

I think it's better to have the page rebuild on push / merge, as documentation updates are seemingly frequent.

@hugginsio what do you think?

tjex commented 2 months ago

Looks like it's not as simple as changing to on-push. https://github.com/zk-org/zk/actions/runs/9860060569/job/27225298529?pr=430

hugginsio commented 2 months ago

Hi @tjex - nice catch!

My reasoning behind only rebuilding on release was so that documentation doesn't get out of sync with the application features. I believe this could be extended to also include pattern matching so that README updates trigger a rebuild.

There might be a place for that down the road, but while documentation gets updated (and maybe eventually overhauled) rebuilding the site on every push is probably better.

hugginsio commented 2 months ago

Looks like it's not as simple as changing to on-push. https://github.com/zk-org/zk/actions/runs/9860060569/job/27225298529?pr=430

That is an unusual error... especially considering we have the id-token set properly, same as the examples?

https://github.com/zk-org/zk/blob/739d2d4fc03512d439fd20cad1eb4caabcbe6c67/.github/workflows/gh-pages.yml#L8-L11

Did anyone make changes to the Actions settings at the organization level since we last deployed to Pages?

tjex commented 2 months ago

Not at the organisation level. We actually never had any secrets / tokens at the org level. The only time I remember talking about secrets was here: https://github.com/zk-org/zk/issues/419#issuecomment-2132978341

But it was to do with homebrew.

Thing is, apart from the homebrew secret. We don't have any other tokens...? There's also no environment secrets set for the gh-pages environment settings in settings -> environments

So I'm actually a bit confused how pages even deployed in the first place 🫤

mcDevnagh commented 2 months ago

https://github.com/zk-org/zk/actions/runs/9895195879 success

tjex commented 2 months ago

Great work all! That was a snappy turn around 💫