ID-159: Update the docs publishing pipeline

[karlnaden]

********** BEFORE MERGING: In the GitHub repository: Settings → Pages → Source — change from "Deploy from a branch" to "GitHub Actions". Without this, the deploy job will fail because the repository isn't configured to accept Actions-based deployments.

Summary

Previously, the pipeline for publishing Ruby documentation and swagger-based JSON API documentation to https://inferno-framework.github.io/ used an old approach. Now, the pipeline uses GitHub Actions.

Testing Guidance

Follow the README instructions on serving the documentation locally (no changes to that process) and verify that the documentation is served as expected.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.79%. Comparing base (7e579f9) to head (10fc941).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #790   +/-   ##
=======================================
  Coverage   89.79%   89.79%           
=======================================
  Files         291      291           
  Lines        8365     8365           
  Branches     2002     2004    +2     
=======================================
  Hits         7511     7511           
  Misses        799      799           
  Partials       55       55           

Flag	Coverage Δ
backend	92.50% <ø> (ø)
frontend	83.71% <ø> (ø)

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

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ljtucker]

Changes look good from a code perspective, but running the system locally as requested in the testing instructions brought me to this page, which does not seem right. If this is the expected page then I'll update this to an approve

[karlnaden]

Changes look good from a code perspective, but running the system locally as requested in the testing instructions brought me to this page, which does not seem right. If this is the expected page then I'll update this to an approve

That is the right page for the root http://localhost:4000/inferno-core page, but you should get to generated documents locally for http://localhost:4000/inferno-core/docs/ and http://localhost:4000/inferno-core/api-docs/. In your screenshot, there is no trailing "/". Chrome adds it automatically for me, but that might be what's causing you to not get to the right page.

NOTE: I noticed some generation warnings and added some fixes to input and return annotations.

[ljtucker]

Even with the slash I am looking at the same screen. The api-docs is rendering though An error was appearing in the logs when I tried hitting that endpoint

[ljtucker]

Update: I missed a command, which triggered the earlier failure comments. Approved