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 gh actions #90

Closed
wants to merge 11 commits into from
Closed

Update gh actions #90

wants to merge 11 commits into from

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Jan 22, 2024

Also, improve website look.

You can also consider adding favicons using pkgdown::build_favicons().

@torfason
Copy link
Collaborator

Hi, thanks for the contribution. I very much appreciate some help in this area since I'm not a great expert on pkdown or GitHub Pages. I've built the new site on my personal fork and am all for the new and lighter theme, as well as the favicons:

To be compared with the main site:

There are a few issues that I would like to see fixed before pushing to the main branch:

  • The Get started page now has an extra icon. Do you know how it might be possible to get rid of this without also getting rid of the Icon when viewing it as the README of the repo itself?
  • Building the site locally (see the build_and_release_process.R) creates local changes, specifically some files with extra icon resolutions get created. Could you add those to the ignore list so that they don't get added to the repo? A clean checkout should generally stay clean even though it is built.
  • If you have any more good ideas for improving the site, feel free to suggest them, the site could definitely use some attention :-)
  • Once we have the final version of this, it would be great if you could squash your branch into a single commit, to keep the main branch clean for future maintenance. Of course, I could also squash it myself, but then the original contributor would not be documented.

Best, Magnus

@olivroy
Copy link
Contributor Author

olivroy commented Jan 23, 2024

Hi, thanks for the contribution. I very much appreciate some help in this area since I'm not a great expert on pkdown or GitHub Pages. I've built the new site on my personal fork and am all for the new and lighter theme, as well as the favicons:

That is a great initiative!

  • The Get started page now has an extra icon. Do you know how it might be possible to get rid of this without also getting rid of the Icon when viewing it as the README of the repo itself?

Fixed! just removed the logo, as pkgdown adds a logo on the top right by default.

  • Building the site locally (see the build_and_release_process.R) creates local changes, specifically some files with extra icon resolutions get created. Could you add those to the ignore list so that they don't get added to the repo? A clean checkout should generally stay clean even though it is built.

You could remove devtools::build_site() from your release script. As the site seems to be built Your release script should not be affected from what I understand. However, you could remove the build These files appear in the docs/` directory which is RBuildignored. and gitignored, the site is deployed from the gh-pages branch. Please clarify what you mean here!

  • Once we have the final version of this, it would be great if you could squash your branch into a single commit, to keep the main branch clean for future maintenance. Of course, I could also squash it myself, but then the original contributor would not be documented.

It is possible to squash and merge on GitHub. On the merge pull request button, you can select Squash. but I do not mind if my name does not appear, it is a very small contribution.
image

@olivroy
Copy link
Contributor Author

olivroy commented Jan 23, 2024

I just updated the gh actions to latest. The workflows are now simpler and use pak under the hood. usethis::use_github_action("check-standard") and usethis::use_github_action("pkgdown").

I also added your commits for the favicons

@olivroy olivroy changed the title Add website to DESCRIPTION Add website to DESCRIPTION + update gh actions Jan 23, 2024
olivroy and others added 2 commits January 23, 2024 08:33
@olivroy olivroy changed the title Add website to DESCRIPTION + update gh actions Update gh actions Jan 23, 2024
@torfason
Copy link
Collaborator

I added all the changes apart from the actions, after squashing the commits for a cleaner history, see #91. I got an error on the actions, something to do with the caching step, so I decided to postpone them for now. So I'll close this PR, we can do another PR on the dev branch for updating the actions. I added you to the contributor's list, thanks for the updates!

@torfason torfason closed this Jan 23, 2024
@olivroy
Copy link
Contributor Author

olivroy commented Jan 23, 2024

Sure thing! thanks. happy to answer any more questions if you have some. Cheers

@olivroy olivroy deleted the patch-1 branch January 23, 2024 17:32
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.

2 participants