Potential API changes for the next major release. This changes will be merged into the development branch main, before they are released on the upcoming v6.0.0 release.

Changes:

• SHA256 Support: The support for SHA256 and SHA1 in parallel may require API changes on plumbing.Hash or where it is currently used.

  • xref: Support for SHA256 #706 Support SHA-1 **and** SHA-256 at the same time #899

• Git config management (TBC)

  • xref: support global config (i.e. $HOME/.gitconfig) #395

• worktree_status.go

  • go-git/worktree_status.go

    Line 273 in cf196ea

    // TODO(mcuadros): deprecate in favor of AddWithOption in v6.

  • go-git/worktree_status.go

    Line 372 in cf196ea

    // TODO(mcuadros): deprecate in favor of AddWithOption in v6.

• difftree.go

  • https://github.com/go-git/go-git/blob/cf196ea5ba6c8b16712a9868cc2d4cca4f287ae4/plumbing/object/difftree.go#L63C1-L63C1

• options.go

  • go-git/options.go

    Line 711 in cf196ea

    // TODO: deprecate in favor of Validate(r *Repository) in v6.

• repository.go

  • go-git/repository.go

    Line 561 in cf196ea

    // TODO(mcuadros): v6, add this as ConfigOptions.Scoped

  • go-git/repository.go

    Line 426 in 0a1c5ab

    // TODO(mcuadros): move isBare to CloneOptions in v5

  • go-git/repository.go

    Line 439 in 0a1c5ab

    // TODO(mcuadros): move isBare to CloneOptions in v5

• server.go

  • go-git/plumbing/transport/server/server.go

    Line 92 in cf196ea

    //TODO: deprecate

• commitgraph

  • plumbing: commitgraph, Allow reading commit-graph chains #854 (comment)

  • go-git/plumbing/format/commitgraph/memory.go

    Line 10 in cf196ea

    // Deprecated: This package uses the wrong types for Generation and Index in CommitData.

  • go-git/plumbing/format/commitgraph/doc.go

    Line 3 in cf196ea

    // Deprecated: This package uses the wrong types for Generation and Index in CommitData.

  • go-git/plumbing/format/commitgraph/encoder.go

    Line 14 in cf196ea

    // Deprecated: This package uses the wrong types for Generation and Index in CommitData.

  • go-git/plumbing/format/commitgraph/file.go

    Line 16 in cf196ea

    // Deprecated: This package uses the wrong types for Generation and Index in CommitData.

  • go-git/plumbing/format/commitgraph/commitgraph.go

    Line 12 in cf196ea

    // Deprecated: This package uses the wrong types for Generation and Index in CommitData.

• make osfs.BoundOS the default osfs for Plain operations.

• All tags not being returned by default. Fix tests TestFetchOfMissingObjects and TestFetchWildcardTags #1459

• New transport API

• config.Version_X -> config.VersionX as part of *: enable revive linter #1771.

• Config validation no longer rejects branch.*.merge values without the ref/ prefix. config parser rejects branch.*.merge values  #1923

• Change zlib types sync.GetZlibWriter / sync.PutZlibWriter utils: sync, Make zlib compression pluggable via x/plugin #2012

utils/sync.GetZlibWriter now returns sync.ZlibWriter (an interface aliased to plugin.ZlibWriter) instead of *zlib.Writer, and PutZlibWriter accepts the same interface. Callers that previously relied on the concrete *zlib.Writer return type will need to update to the interface, whose method set is Write, Close, Reset(io.Writer), and Flush.

• .gitignore logic now matches upstream, which was not always the case up to v5. Implement Git-compatible wildmatch for gitignore patterns #1940

Potential breaking changes:

• repository.go

  • go-git/repository.go

    Line 440 in 0a1c5ab

    // TODO(smola): refuse upfront to clone on a non-empty directory in v5, see #1027

• Git config management (TBC)
  • xref: support global config (i.e. $HOME/.gitconfig) #395
• Need to .Close() repositories as part of git: add Repository.Close(), use it in tests to fix Windows file handle leak #1906.