Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-pages build on push, not release #430

Merged
merged 2 commits into from
Jul 11, 2024
Merged

gh-pages build on push, not release #430

merged 2 commits into from
Jul 11, 2024

Conversation

tjex
Copy link
Member

@tjex tjex commented Jul 9, 2024

The gh pages fix from #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 tjex requested a review from mcDevnagh July 9, 2024 15:37
@tjex
Copy link
Member Author

tjex commented Jul 9, 2024

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
Copy link
Contributor

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
Copy link
Contributor

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?

permissions:
contents: read
pages: write
id-token: write

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

@tjex
Copy link
Member Author

tjex commented Jul 10, 2024

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: #419 (comment)

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 🫤

Copy link
Contributor

@mcDevnagh mcDevnagh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldn't deploy on PR. Only if main is updated

@tjex tjex requested a review from mcDevnagh July 11, 2024 06:36
@mcDevnagh mcDevnagh merged commit f0ed61c into zk-org:main Jul 11, 2024
3 checks passed
@mcDevnagh
Copy link
Contributor

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

@tjex
Copy link
Member Author

tjex commented Jul 13, 2024

Great work all! That was a snappy turn around 💫

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants