Skip to content

docs(time-freezing): correct the Go version claim — works on all supported Go releases#861

Merged
gouravkrosx merged 1 commit into
mainfrom
fix/time-freezing-go-version-claim
May 18, 2026
Merged

docs(time-freezing): correct the Go version claim — works on all supported Go releases#861
gouravkrosx merged 1 commit into
mainfrom
fix/time-freezing-go-version-claim

Conversation

@gouravkrosx
Copy link
Copy Markdown
Member

@gouravkrosx gouravkrosx commented May 18, 2026

Summary

The two current time-freezing pages (versions 3.0.0 and 4.0.0) both carried the same incorrect note:

Note: Time freezing is only supported till go 1.22.x version.

That's wrong. The mechanism is build-time — -tags=faketime is a Go build tag that swaps runtime.now() to read from the freeze-time agent file instead of the OS clock — so it applies to any Go version that supports the build tag, which is every currently-supported release.

How this surfaced

An AI agent walking the Keploy MCP onboarding flow read the existing note, propagated the false "Requires Go 1.22.x" comment into a user's Dockerfile, and would have rejected newer Go versions. Updating the docs so the next agent (or human) reading the page gets accurate guidance.

Change

One-line replacement in versions 3.0.0 and 4.0.0. New text states the build-tag mechanism explicitly so a reader understands why the Go-version constraint doesn't apply:

Note: Time freezing works on every Go version that supports the faketime build tag — i.e. all currently-supported Go releases. The mechanism is build-time (the -tags=faketime flag swaps Go's time package to read from a runtime agent file instead of the OS clock), so it's not tied to any specific Go version.

Version 2.0.0 is intentionally left untouched (historical / archived).

Test plan

  • Docusaurus build is green (no broken links / lint).
  • Live site preview shows the new note on the version-3.0.0 and version-4.0.0 time-freezing pages.

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings May 18, 2026 15:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the “Time Freezing” documentation across multiple versioned docs to remove an incorrect Go 1.22.x limitation and explain that the feature is enabled via the faketime build tag.

Changes:

  • Replaces the “only supported till go 1.22.x” note in v2.0.0, v3.0.0, and v4.0.0 docs.
  • Adds a more detailed explanation describing time freezing as build-time behavior via -tags=faketime.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md Updates the Go version compatibility note for time freezing in v4 docs.
versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md Updates the Go version compatibility note for time freezing in v3 docs.
versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md Updates the Go version compatibility note for time freezing in v2 docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

### For Golang(Go) Applications -

> Note: Time freezing is only supported till go **1.22.x** version.
> Note: Time freezing works on every Go version that supports the `faketime` build tag — i.e. all currently-supported Go releases. The mechanism is build-time (the `-tags=faketime` flag swaps Go's `time` package to read from a runtime agent file instead of the OS clock), so it's not tied to any specific Go version.
### For Golang(Go) Applications -

> Note: Time freezing is only supported till go **1.22.x** version.
> Note: Time freezing works on every Go version that supports the `faketime` build tag — i.e. all currently-supported Go releases. The mechanism is build-time (the `-tags=faketime` flag swaps Go's `time` package to read from a runtime agent file instead of the OS clock), so it's not tied to any specific Go version.
### For Golang(Go) Applications -

> Note: Time freezing is only supported till go **1.22.x** version.
> Note: Time freezing works on every Go version that supports the `faketime` build tag — i.e. all currently-supported Go releases. The mechanism is build-time (the `-tags=faketime` flag swaps Go's `time` package to read from a runtime agent file instead of the OS clock), so it's not tied to any specific Go version.
@gouravkrosx gouravkrosx force-pushed the fix/time-freezing-go-version-claim branch 2 times, most recently from 4824e2b to e36485c Compare May 18, 2026 15:57
…orted Go releases

The two current time-freezing pages (versions 3.0.0 and 4.0.0) both carried
the same incorrect note:

  > Note: Time freezing is only supported till go **1.22.x** version.

That hasn't been true for a while. The mechanism is build-time —
`-tags=faketime` is a Go build tag that swaps `runtime.now()` to read
from the freeze-time agent file instead of the OS clock — so it
applies to any Go version that supports the build tag, which is every
currently-supported release.

Caught when an AI agent walking the Keploy MCP onboarding flow read
the existing note, propagated the false "Requires Go 1.22.x" comment
into a user's Dockerfile, and rejected newer Go versions. Updating
the docs so the next agent (or human) reading the page gets accurate
guidance.

Replacement text leans positive: states the build-tag mechanism
explicitly so a reader understands why the Go-version constraint
doesn't apply.

Scope intentionally excludes version-2.0.0 (historical / archived
docs — not surfaced as current to live readers).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com>
@gouravkrosx gouravkrosx force-pushed the fix/time-freezing-go-version-claim branch from e36485c to 193064e Compare May 18, 2026 15:59
@gouravkrosx gouravkrosx merged commit e3e3603 into main May 18, 2026
7 checks passed
@gouravkrosx gouravkrosx deleted the fix/time-freezing-go-version-claim branch May 18, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants