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

Only build & deploy pkgdown on release #529

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Conversation

kamilzyla
Copy link
Collaborator

@kamilzyla kamilzyla commented Jan 9, 2024

Changes

Closes #527:

  1. Trigger our pkgdown.yml workflow on release instead of push. This way our website will show docs for the latest release instead of development version.
  2. Document the change.

This should resolve our immediate problem of confusing users. Ideally we'd allow users select the documentation version to browse, but I haven't found any simple way to achieve it. I have summarized my research in a new issue: #530.

How to test

We'll see if this works as expected when we release Rhino 1.6.

If needed, we can manually trigger the workflow for any tag/branch. I used this to deploy v1.5 docs now. I used a temporary branch (tmp-docs-1.5) instead of v1.5.0 tag to include the CSS fix from #517.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6926a37) 17.82% compared to head (5983bce) 17.82%.

❗ Current head 5983bce differs from pull request most recent head 0ea8aa6. Consider uploading reports for the commit 0ea8aa6 to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #529   +/-   ##
=======================================
  Coverage   17.82%   17.82%           
=======================================
  Files           9        9           
  Lines         404      404           
=======================================
  Hits           72       72           
  Misses        332      332           

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

Copy link
Member

@jakubnowicki jakubnowicki left a comment

Choose a reason for hiding this comment

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

LGTM

@kamilzyla kamilzyla merged commit a5da6c5 into main Jan 9, 2024
20 checks passed
@kamilzyla kamilzyla deleted the show-released-docs branch January 9, 2024 12:45
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.

Rhino website uses the development branch
3 participants