obs-studio icon indicating copy to clipboard operation
obs-studio copied to clipboard

CI/docs: Some fixes for CF Pages publishing

Open derrod opened this issue 2 years ago • 4 comments

Description

  • Disables beta/rc tags being published to live page
  • Runs version update step for workflow_dispatch as well
  • Sphinx output is now created without .html suffix in Links to avoid unnecessary redirects on CF's platform

Note: This would break browing the docs locally unless they're hosted on a webserver that is configured to support extension-less URLs.

Motivation and Context

Fixing good.

How Has This Been Tested?

Tested on my fork: https://obs-docs-test.pages.dev/

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Tweak (non-breaking change to improve existing functionality)

Checklist:

  • [x] My code has been run through clang-format.
  • [x] I have read the contributing document.
  • [x] My code is not on the master branch.
  • [x] The code has been tested.
  • [x] All commit messages are properly formatted and commits squashed where appropriate.
  • [x] I have included updates to all appropriate documentation.

derrod avatar Feb 01 '23 18:02 derrod

Note: This would break browing the docs locally unless they're hosted on a webserver that is configured to support extension-less URLs.

This is unfortunate. If I'm checking docs builds, I load them locally in a browser without running a webserver. @WizardCM thoughts?

RytoEX avatar Feb 03 '23 15:02 RytoEX

I think there are two ways to keep offline docs working:

  • Only use extension-less links on workflow_disaptch or tags so normal pushes create regular docs
  • Generate second set of docs with different settings for publishing only

derrod avatar Feb 03 '23 17:02 derrod

@derrod I vote for the second option. Docs should always generate user-usable ZIPs, including alongside CF Pages runs.

WizardCM avatar Feb 04 '23 23:02 WizardCM

Updated based on @WizardCM's and @RytoEX's feedback so that the workflow generates a separate artifact for CF pages and the normal artifact remains locally browseable.

derrod avatar Feb 05 '23 15:02 derrod

Artifact has HTML files, though the version in the docs is seemingly outdated.

image

RytoEX avatar Feb 15 '23 15:02 RytoEX

Artifact has HTML files, though the version in the docs is seemingly outdated.

The step to update the version number doesn't run for PRs. Not sure why that was originally done.

derrod avatar Feb 15 '23 15:02 derrod

Artifact has HTML files, though the version in the docs is seemingly outdated.

The step to update the version number doesn't run for PRs. Not sure why that was originally done.

Then I suppose it's a non-issue. Will merge shortly.

RytoEX avatar Feb 15 '23 15:02 RytoEX