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

Update logo on "stable" documentation page #9

Open
kdpsingh opened this issue Mar 28, 2023 · 8 comments
Open

Update logo on "stable" documentation page #9

kdpsingh opened this issue Mar 28, 2023 · 8 comments

Comments

@kdpsingh
Copy link
Member

The "stable" docs continue to show the old logo even though the "dev" docs show the updated logo. We should fix this.

I think we may need to directly check out the gh-pages branch and make edits there. I don't think it's possible to fix it upstream of the GitHub action but I'm not 100% sure.

@pdimens or @lazarusA, do you happen to know?

@pdimens
Copy link
Contributor

pdimens commented Mar 28, 2023

Stable links to 0.5.0, which doesn't get rebuilt. In the assets folder, 0.5.0 still has the old logo. You can just replace it manually https://github.com/kdpsingh/Tidier.jl/blob/gh-pages/v0.5.0/assets/Tidier_jl_logo.png

@kdpsingh
Copy link
Member Author

Oh I didn't realize. I just assumed "stable" pointed to the latest released version. I can swap it out.

I wonder if the fact it's pointing to 0.5 is intentional (something to do with Documenter.jl) vs. something I have mis-configured that isn't updating the docs after release.

@pdimens
Copy link
Contributor

pdimens commented Mar 28, 2023

I use Docusaurus instead of Documenter.jl so I can't provide any wisdom on that point, maybe @lazarusA might know. It would make sense for stable to match the latest release though.

@kdpsingh
Copy link
Member Author

kdpsingh commented Mar 28, 2023

Actually I think I know what it is. Since v0.5.0, I fixed the RegistratorBot so that it automatically creates a release on GitHub after the commit is merged with the Julia registry (as opposed to me manually having to do it). My guess is that this workflow isn't triggering the GitHub action to update the Stable docs page.

@kdpsingh
Copy link
Member Author

Are any of you experienced with GitHub actions to help figure out where a hook isn't triggering but should be? @rdboyes @pitmonticone

I think this is why the "stable" documentation isn't updating following each release. I used to manually tag releases but now it's automated by the RegistratorBot or TagBot.

@pitmonticone
Copy link
Member

Hi @kdpsingh, are you using SSH deploy keys?

I'm asking because I know that the default TagBot setup that uses the GITHUB_TOKEN doesn't have the permissions to trigger docs builds (see here for further details).

@kdpsingh
Copy link
Member Author

I don't think so. Will read more about this.

What's weird is that up until v0.5.0, I was manually creating the release in GitHub and that was triggering the stable docs build just fine.

But I believe you're right - if TagBot doesn't have permission to run this process, that's probably why stable docs aren't updating.

@pitmonticone
Copy link
Member

Yes, I tend to believe that if you create the SSH key with write permission and the associated repository secret everything should work as expected.

@kdpsingh kdpsingh transferred this issue from TidierOrg/Tidier.jl Jul 31, 2023
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

No branches or pull requests

3 participants