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

GHA: add a workflow to build the pkgdown site on PR #626

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

Bai-Li-NOAA
Copy link
Contributor

What is the feature?

This PR addresses issue #595. It enables FIMS to render the pkgdown site on pull requests.

How have you implemented the solution?

Thanks, @k-doering-NOAA, for adding a reusable workflow to {ghactions4r}. The workflow call-build-pkgdown.yml has been added to FIMS to use this reusable workflow.

Does the PR impact any other area of the project?

No

How to test this change

It has been tested on the feature branch, and the pkgdown site materials have been successfully uploaded on Actions page here

Developer pre-PR checklist

  • I relied on GitHub actions to 🧪 things for me while I sat on the 🛋️.

Copy link
Contributor

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@Bai-Li-NOAA Bai-Li-NOAA linked an issue Jun 13, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jun 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.56%. Comparing base (2c16ff4) to head (6f86bcc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #626   +/-   ##
=======================================
  Coverage   78.56%   78.56%           
=======================================
  Files          36       36           
  Lines        1945     1945           
  Branches      141      141           
=======================================
  Hits         1528     1528           
  Misses        374      374           
  Partials       43       43           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@k-doering-NOAA k-doering-NOAA left a comment

Choose a reason for hiding this comment

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

Hi @Bai-Li-NOAA , sorry for the delay on this! I had one question, but otherwise I think it looks good.

.github/workflows/call-build-pkgdown.yml Show resolved Hide resolved
@Bai-Li-NOAA Bai-Li-NOAA force-pushed the 595-render-pkgdown-on-pr branch 2 times, most recently from a72592a to 4ef80fc Compare June 20, 2024 13:17
Copy link
Member

@k-doering-NOAA k-doering-NOAA left a comment

Choose a reason for hiding this comment

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

Sorry for dropping the ball on this one - looks ready to merge in to me!

@kellijohnson-NOAA I'll leave this for you to decide how you would like to merge in (I assume rebasing to catch up, then rebase in, but I wasn't sure)

@Bai-Li-NOAA Bai-Li-NOAA force-pushed the 595-render-pkgdown-on-pr branch from 4ef80fc to 6f86bcc Compare June 26, 2024 15:11
@Bai-Li-NOAA
Copy link
Contributor Author

Thank you, @k-doering-NOAA. I have rebased the branch.

@Bai-Li-NOAA Bai-Li-NOAA merged commit 0296e41 into main Jun 26, 2024
14 checks passed
@Bai-Li-NOAA Bai-Li-NOAA deleted the 595-render-pkgdown-on-pr branch June 26, 2024 16:13
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.

[Developer Issue]: Render pkgdown website on pull request
3 participants