Skip to content

docs: add v1.17.4 and v1.18.1 upgrade notes and polish zh-CN translation - #200

Merged
hwbrzzl merged 8 commits into
masterfrom
upgrade/v1.17.4-v1.18.1
Nov 12, 2026
Merged

hwbrzzl merged 8 commits into
masterfrom
upgrade/v1.17.4-v1.18.1

Conversation

@goravel-agent

@goravel-agent goravel-agent commented Sep 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add the ## v1.17.4 and ## v1.18.1 upgrade sections to the v1.17 and v1.18 pages, in English and 简体中文, each note written from the application developer's side: what changed, who is affected and what to do before upgrading.
  • Document the fixes both releases share — the migration ledger row on a non-default connection, session ID validation and logged-out JWT reuse, the memory cache Flush crash and expiry race, concurrent translation, Paginate bounds, chunked Each, quoted column names, Cursor connection release and the otel log level — plus the v1.18.1 WithCommandsFilter behaviour and the Gin and Fiber driver fixes.
  • Write the 简体中文 notes as Chinese rather than a literal translation, with headings and TOC anchors that match the English pages, and add the missing Process facade to the Lite facade list in the English v1.17 page.

Why

The v1.17.4 and v1.18.1 patch releases ship user-facing bug fixes that had no upgrade notes, so anyone moving onto either version had nowhere to read what changed and whether they need to act. The new sections sit next to the existing v1.17.3 and v1.18.0 notes and describe each fix from the user's point of view rather than the internal code change. No existing note is rewritten: the only edit outside the new sections is the Process facade in the English Lite list, which the framework ships but the page omitted.

Most of the notes document behaviour only, but two need a change in your application, and the notes say so explicitly: Cursor() releases its rows and connection when the context is cancelled, so cancel the context when you leave the loop early, and the Gin driver now enforces http.drivers.gin.body_limit, so raise it before upgrading if you accept uploads larger than 4 MB.

// Before: breaking out of the loop leaked the goroutine, the rows and the connection.
for row := range facades.Orm().Query().Model(models.Invoice{}).Cursor() {
  var invoice models.Invoice
  if err := row.Scan(&invoice); err != nil {
    return err
  }

  if invoice.Total > 10000 {
    break
  }
}

// After: the context is cancelled, so Cursor() releases the rows and the connection.
ctx, cancel := context.WithCancel(ctx)
defer cancel()

cursor := facades.Orm().WithContext(ctx).Query().Model(models.Invoice{}).Cursor()
for row := range cursor {
  var invoice models.Invoice
  if err := row.Scan(&invoice); err != nil {
    return err
  }

  if invoice.Total > 10000 {
    cancel()
    break
  }
}
// Before: body_limit was never enforced, so a large upload was read in full.
// config/http.go
"gin": map[string]any{
    "body_limit":   4096,
    "header_limit": 4096,
}

// After: bodies over the limit get 413, so raise it to accept the upload.
// config/http.go
"gin": map[string]any{
    "body_limit":   10240, // 10 MB, was 4096
    "header_limit": 4096,
},

Comment thread en/upgrade/v1.17.md Resolved
Comment thread en/upgrade/v1.18.md Resolved
@goravel-agent
goravel-agent force-pushed the upgrade/v1.17.4-v1.18.1 branch from 1daa602 to 913ab57 Compare November 9, 2026 07:20
Comment thread zh_CN/upgrade/v1.17.md Resolved
@goravel-agent goravel-agent changed the title docs: add v1.17.4 and v1.18.1 upgrade notes docs: add v1.17.4 and v1.18.1 upgrade notes and polish zh-CN translation Nov 9, 2026

@hwbrzzl hwbrzzl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@goravel-agent solve comments

Comment thread zh_CN/upgrade/v1.17.md Resolved
Comment thread zh_CN/upgrade/v1.18.md Resolved
@hwbrzzl
hwbrzzl merged commit 539ef7a into master Nov 12, 2026
1 check passed
@hwbrzzl
hwbrzzl deleted the upgrade/v1.17.4-v1.18.1 branch November 12, 2026 15:37
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.

2 participants