Add ``last updated`` for document by FishAlchemist · Pull Request #11164 · astral-sh/uv

FishAlchemist · 2025-02-02T11:09:02Z

Summary

Display the last document update time, excluding any automatically generated parts of the document, while ensuring that Google can accurately read and recognize the webpage's time.

Note that I do not have permission to update requirements-insiders.txt

Google time info

Similar #11162
Closes #11148

Test Plan

uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml --strict

The correct format is actually 2024-08-08T22:01:08Z, but Google Search happens to be lenient and accepts this format.

FishAlchemist · 2025-02-02T11:12:43Z

I just stepped out, planning to set up Google time and then open a PR when I got back. Unexpectedly, someone beat me to it. See which version you want to use, I just don't want my time to be wasted, so I'm throwing it up for reference.
#11162

FishAlchemist · 2025-02-02T12:03:06Z

By the way, the website does not currently support rich results, so even if you set a time, it will not take effect.
https://search.google.com/test/rich-results/result?id=oQWO7tBph2rXt81M4uuAKg&hl=en

FishAlchemist · 2025-02-02T12:12:45Z

mkdocs.public.yml

 plugins:
  - search
+  - git-revision-date-localized:
+      timezone: UTC # It can only be in UTC unless the ISO time can include timezone.


Actually, I don't want to specifically target UTC(Default UTC), but unfortunately, git_revision_date_localized_raw_iso_datetime doesn't include the timezone offset. So, if you want to change the timezone, you also need to modify the JSON-LD information for Google Search to recognize it.

https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/blob/v1.3.0/src/mkdocs_git_revision_date_localized_plugin/dates.py#L42-L45

"iso_date": loc_revision_date.strftime("%Y-%m-%d"), "iso_datetime": loc_revision_date.strftime("%Y-%m-%d %H:%M:%S"),

FishAlchemist · 2025-02-02T12:54:33Z

.github/workflows/publish-docs.yml

      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.ref }}
+          fetch-depth: 0


https://github.com/timvink/mkdocs-git-revision-date-localized-plugin?tab=readme-ov-file#note-when-using-build-systems-like-github-actions

mkdocs.public.yml

charliermarsh

Thanks!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.27` -> `0.5.29` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.5.29`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0529) [Compare Source](astral-sh/uv@0.5.28...0.5.29) ##### Enhancements - Add `--bare` option to `uv init` ([#11192](astral-sh/uv#11192)) - Add support for respecting `VIRTUAL_ENV` in project commands via `--active` ([#11189](astral-sh/uv#11189)) - Allow the project `VIRTUAL_ENV` warning to be silenced with `--no-active` ([#11251](astral-sh/uv#11251)) ##### Python The managed Python distributions have been updated, including: - CPython 3.12.9 - CPython 3.13.2 - pkg-config files are now relocatable See the [`python-build-standalone` release notes](https://github.com/astral-sh/python-build-standalone/releases/tag/20250205) for more details. ##### Bug fixes - Always use base Python discovery logic for cached environments ([#11254](astral-sh/uv#11254)) - Use a flock to avoid concurrent initialization of project environments ([#11259](astral-sh/uv#11259)) - Fix handling of `--all-groups` and `--no-default-groups` flags ([#11224](astral-sh/uv#11224)) ##### Documentation - Minor touchups to the Docker provenance docs ([#11252](astral-sh/uv#11252)) - Move content from the `mkdocs.public.yml` into the template ([#11246](astral-sh/uv#11246)) ### [`v0.5.28`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0528) [Compare Source](astral-sh/uv@0.5.27...0.5.28) ##### Bug fixes - Allow discovering virtual environments from the first interpreter found on the `PATH` ([#11218](astral-sh/uv#11218)) - Clear ephemeral overlays when running tools ([#11141](astral-sh/uv#11141)) - Disable SSL in Git commands for `--allow-insecure-host` ([#11210](astral-sh/uv#11210)) - Fix hardlinks in tar unpacking ([#11221](astral-sh/uv#11221)) - Set base executable when returning virtual environment ([#11209](astral-sh/uv#11209)) - Use base Python for cached environments ([#11208](astral-sh/uv#11208)) ##### Documentation - Add documentation on verifying Docker image attestations ([#11140](astral-sh/uv#11140)) - Add `last updated` to documentation ([#11164](astral-sh/uv#11164)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

I am bothered by the positioning of this immediately following the content. I explored some other things, like forcing it the bottom of the article, but in the end it was easiest to just hide it entirely I think this belongs somewhere else, like in the footer — but I believe that requires theme changes which are a bit more complicated than its worth. https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/howto/override-a-theme/ The main goal here was SEO metadata anyway. Originally added in #11164 Before <img width="1334" alt="Screenshot 2025-02-24 at 12 57 56 PM" src="https://github.com/user-attachments/assets/3f7423ff-fc18-40e8-be8a-f2e611af8221" /> Now, it's omitted.

I am bothered by the positioning of this immediately following the content. I explored some other things, like forcing it the bottom of the article, but in the end it was easiest to just hide it entirely I think this belongs somewhere else, like in the footer — but I believe that requires theme changes which are a bit more complicated than its worth. https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/howto/override-a-theme/ The main goal here was SEO metadata anyway. Originally added in astral-sh#11164 Before <img width="1334" alt="Screenshot 2025-02-24 at 12 57 56 PM" src="https://github.com/user-attachments/assets/3f7423ff-fc18-40e8-be8a-f2e611af8221" /> Now, it's omitted.

FishAlchemist force-pushed the add_last_updated branch from a7a4680 to fc04b2d Compare February 2, 2025 11:30

FishAlchemist changed the title ~~Add last updated for doc~~ Add last updated for document Feb 2, 2025

FishAlchemist commented Feb 2, 2025

View reviewed changes

konstin requested a review from zanieb February 2, 2025 13:09

charliermarsh reviewed Feb 3, 2025

View reviewed changes

mkdocs.public.yml Outdated Show resolved Hide resolved

FishAlchemist force-pushed the add_last_updated branch from e0a2e58 to 7aa0dd3 Compare February 4, 2025 03:05

FishAlchemist added 4 commits February 4, 2025 11:06

Added mkdocs-git-revision-date-localized-plugin for show last updated

75d4ae3

Get the correct time for Google

1df2485

Build the document with fetch-depth set to 0.

3314a72

Revoke the exclusion of automatically generated documents.

855021e

FishAlchemist force-pushed the add_last_updated branch from 7aa0dd3 to 855021e Compare February 4, 2025 03:06

charliermarsh approved these changes Feb 4, 2025

View reviewed changes

charliermarsh merged commit 49b85d2 into astral-sh:main Feb 4, 2025
73 checks passed

BrewTestBot mentioned this pull request Feb 5, 2025

uv 0.5.28 Homebrew/homebrew-core#206582

Merged

mschoettle mentioned this pull request Feb 12, 2025

Add rich result data to blog articles mschoettle/website#80

Open

charliermarsh mentioned this pull request Feb 14, 2025

Uv #11148 Add last updated field to docs #11162

Closed

zanieb mentioned this pull request Feb 24, 2025

Remove the last edited date from documentation pages #11753

Merged

FishAlchemist deleted the add_last_updated branch June 17, 2025 06:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `last updated` for document#11164

Add `last updated` for document#11164
charliermarsh merged 4 commits intoastral-sh:mainfrom
FishAlchemist:add_last_updated

FishAlchemist commented Feb 2, 2025 •

edited

Loading

Uh oh!

FishAlchemist commented Feb 2, 2025

Uh oh!

FishAlchemist commented Feb 2, 2025

Uh oh!

FishAlchemist Feb 2, 2025 •

edited

Loading

Uh oh!

FishAlchemist Feb 2, 2025

Uh oh!

Uh oh!

charliermarsh left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

FishAlchemist commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

FishAlchemist commented Feb 2, 2025

Uh oh!

FishAlchemist commented Feb 2, 2025

Uh oh!

FishAlchemist Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FishAlchemist Feb 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

charliermarsh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

FishAlchemist commented Feb 2, 2025 •

edited

Loading

FishAlchemist Feb 2, 2025 •

edited

Loading