cvat icon indicating copy to clipboard operation
cvat copied to clipboard

Switch to deploying GitHub Pages via an action

Open SpecLad opened this issue 6 months ago • 2 comments

Motivation and context

Currently, we're using the original deployment method of pushing to the gh-pages branch. Since the actual content is generated via a workflow, we can skip the pushing, and just publish directly to Pages from the workflow.

This has the following benefits:

  • It should be a bit faster, since we're skipping a step.
  • It makes the repository lighter (provided we delete the gh-pages branch).
  • It lets you preview what pages will be deployed after a PR, since they are published as a workflow artifact.
  • It lets us avoid using a 3rd-party action.

Note that actions/deploy-pages has no equivalent of the cname parameter. Instead, the domain name is set in GitHub's repository settings.

How has this been tested?

Checklist

  • [x] I submit my changes into the develop branch
  • ~~[ ] I have created a changelog fragment~~
  • ~~[ ] I have updated the documentation accordingly~~
  • ~~[ ] I have added tests to cover my changes~~
  • ~~[ ] I have linked related issues (see GitHub docs)~~

License

  • [x] I submit my code changes under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

SpecLad avatar May 02 '25 10:05 SpecLad

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.80%. Comparing base (5aa5fd0) to head (891c70a). Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #9386   +/-   ##
========================================
  Coverage    71.80%   71.80%           
========================================
  Files          441      441           
  Lines        46389    46389           
  Branches      3960     3960           
========================================
+ Hits         33308    33310    +2     
+ Misses       13081    13079    -2     
Components Coverage Δ
cvat-ui 77.70% <ø> (+<0.01%) :arrow_up:
cvat-server 67.13% <ø> (ø)
:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov-commenter avatar May 02 '25 14:05 codecov-commenter

@azhavoro Could you take a look?

SpecLad avatar Jul 23 '25 10:07 SpecLad