Show the app version, last update and commit in the docs site footer, with the copyright line #200
No reviewers
Labels
No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
ethan-hann/SavePoint!200
Loading…
Reference in a new issue
No description provided.
Delete branch "issue-194-docs-footer"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Closes #194.
The documentation site gave no way to tell which version of SavePoint its pages describe or when they were built. Every page now ends in a three-column footer: "Written for SavePoint " (linked to that release) above "Updated <commit time, UTC> from " (linked to the commit); "Copyright (c) Ethan Hann"; and the GPL line.
build/docs-footer.sh builds the footer HTML from Directory.Build.props and the commit (version, UTC time, year, links from GITHUB_SERVER_URL and GITHUB_REPOSITORY, everything HTML-escaped), and docs.yml passes it to docfx as --metadata _appFooter. A local build keeps a fallback in docfx.json ("Built locally", the copyright without a year, the license). The theme fixed the footer at 60px, which cut off the stacked column, so main.css lets the footer fit its content; the columns stack below 768px and the links are underlined like the rest of the site. Directory.Build.props joins the docs workflow's path filters, so a version bump republishes the site with the new version.
Tests: DocsFooterScriptTests (10, run the script against a temp repo with a commit dated across a year boundary in another time zone; they skip on Windows like the other bash-script tests) and DocsWorkflowTests (5, the workflow passes the script's output, the checkout and path filters, the fallback). The local Windows gate passed on this branch, and the layout was checked in a browser at desktop and narrow widths.