ci: improve the release docs workflow

[RebeccaStevens]

PR Checklist

• Addresses an existing open issue: fixes 🛠 CI: release_docs/update_and_deploy_docs is failing #191
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

The same issue as RebeccaStevens/uom-types#55

Before Merge

gh-pages branch need to be created. Create with:

git switch --orphan gh-pages
git commit --allow-empty -m "initial docs" --no-verify
git push

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5081005) 80.22% compared to head (0d34d4d) 80.22%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #254   +/-   ##
=======================================
  Coverage   80.22%   80.22%           
=======================================
  Files          35       35           
  Lines        6406     6406           
  Branches      360      360           
=======================================
  Hits         5139     5139           
  Misses       1267     1267           

Flag	Coverage Δ
4.3.5	80.00% <ø> (ø)
4.6.4	80.03% <ø> (ø)
4.9.5	80.03% <ø> (ø)
latest	80.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[RebeccaStevens]

Hmm, not sure if there's a nice way to ignore those spelling issues other than just adding the detected words to the cspell dictionary.

[RebeccaStevens]

Pushed a new update that rework the docs workflows a bit. They aren't fully tested as testing workflows is hard, but hopefully they work as intended.

[JoshuaKGoldberg]

Cool! This is getting a bit complicated and long term I think it'd be nice to extract the logic out into its own reusable workflows. But for now it feels reasonable to just go with it. Thanks!

[JoshuaKGoldberg]

👋 ping @RebeccaStevens, is this something you're interested in and have time for?

[RebeccaStevens]

What's the status of this? What needs doing?

[JoshuaKGoldberg]

I'd left a few questions for you in comment threads. I'm up for merging as-is with the suggested touchups, but didn't want to steamroll past you. 🙂

[RebeccaStevens]

I've rebased this off #341 and made a few updates.
This PR should be pretty much ready now.

[JoshuaKGoldberg]

Cool, thanks! Let's give this a shot. 🚀