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

feat: Update documentation action, bump version for local testing #2820

Merged
merged 3 commits into from
Nov 26, 2024

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This commit bumps the theme version for the documentation website, and updates the GitHub action used for deploying the website. The update allows you to specify what version of the theme to use for a deployment, which reduces the drift compared to relying on the local version.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


@ADubhlaoich ADubhlaoich requested review from a team as code owners November 26, 2024 16:41
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 26, 2024
This commit bumps the theme version for the documentation website, and
updates the GitHub action used for deploying the website. The update
allows you to specify what version of the theme to use for a deployment,
which reduces the drift compared to relying on the local version.
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.75%. Comparing base (9928702) to head (97eba95).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2820      +/-   ##
==========================================
- Coverage   89.86%   89.75%   -0.12%     
==========================================
  Files         107      106       -1     
  Lines       10997    10768     -229     
  Branches       50        0      -50     
==========================================
- Hits         9883     9665     -218     
+ Misses       1054     1043      -11     
  Partials       60       60              

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

Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

thanks alan!

@ADubhlaoich ADubhlaoich merged commit d223025 into nginxinc:main Nov 26, 2024
42 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-theme-tooling branch November 26, 2024 17:34
ADubhlaoich added a commit to ADubhlaoich/ngf-doc-work that referenced this pull request Nov 27, 2024
…inxinc#2820)

This commit bumps the theme version for the documentation website, and
updates the GitHub action used for deploying the website. The update
allows you to specify what version of the theme to use for a deployment,
which reduces the drift compared to relying on the local version.

Co-authored-by: bjee19 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants