Update 'github-pages.yaml' Workflow - Fix several warnings & enable Caching pip packages

[og-mrk]

Type of Change

• Refactoring
• CI/CD improvement

Description

This PR Makes github-pages.yaml Workflow more maintainable/readable, also makes git-revision-date-localized-plugin plugin work by pull all commit history (see references for more info), and make github-pages.yaml generate no warnings*.. Except for nodejs warning, which can be resolved by updating actions/setup-python to v5.. but it can't be done at the moment, as it's pinned to use v4 or less. The reason behind this version pinning is unclear... Fixed in this commit, see my review comments on why I've updated this action.

Nonetheless, these changes should make github-pages.yaml workflow cache the results (downloads) of pip packages, and these packages are specified in the new requirements.txt file, which's a common file used in Python Environments, which specifies every package to install, and what version to use, using PackageName==SpecificVersion Syntax.

How to make requirements.txt File (Step By Step)

Testing

Ran this GitHub Action manually on this PR Branch, and it works as expected.

Note

The first run would take much longer then next runs.. as it's compressing & using GitHub's Built-in functionality of Caching between Workflow Runs, more info can be found in references below.

Impact

Won't have a much impact on building/deploying the Docs website.. it'll shave a few seconds here & there, but IMHO it's better than nothing, and lowering Runtime Usage is always a good thing.

Issue related to PR

• Resolves GitHub Pages Workflow Shows a Warning on the Caching Step #2417

Additional Information (References)

• Fetch all history for all tags and branches - actions/checkout
• About caching workflow dependencies - GitHub Docs
• Caching packages dependencies - actions/python-setup
• Python Requirements.txt – How to Create and Pip Install Requirements.txt in Python - freecodecamp.org
• How do I remove all packages installed by pip? - StackOverFlow
• How to properly disable warnings and set logging to error for every library mkdocs uses? - mkdocs/mkdocs GitHub Discussion

Checklist

• My code adheres to the coding and style guidelines of the project.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no errors/warnings/merge conflicts.

[og-mrk]

@ChrisTitusTech

[og-mrk]

Reason behind upgrading actions/setup-python to v5 is pretty simple.. it just works after upgrading this action, and I can confirm this after testing it in a new branch.

I've branched-out & committed/pushed a very simple commit, which even after deleting the branch, still exists thanks to GitHub having everything stay even after "Deleting" it, which's an awesome feature for some people.. but somewhat terrifying to others, but nonetheless.. it does work & produces no errors/fails to build & deploy the docs website, link to the run.

[og-mrk]

Please read this review comment to understand why I've removed this Dependabot Rule.

[og-mrk]

Specifying each and every dependency & sub-dependency (and even sub-sub-dependency) is a great thing IMO, as not only does it show what we install.. but also what VERSION we should be using. Of course this's mainly used as a setup file. You run pip install -r requirements.txt, and you're off to the races!

If you want to update or add a new package (which may or may not require dependencies).. you can search online on how to properly update this file, I've done it with the most simple & straight forward way.. which's uninstalling every package, clearing the cache, and then install the packages required to build & deploy the docs website, see PR description for more details on the steps, and which "main" packages I've installed, which'll generate a similar list like the one below.

[ChrisTitusTech]

A great idea so dependabot doesn't screw us on a bad update. Thanks @og-mrk