Introduction

This document lists changes made to the Git Library API.

Index of APIs

Git Library

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

(Mar 12 '13) Adding support comparing trees of arbitrary commits
(Mar 11 '13) Adding support for rebase to the API
(Feb 6 '13) Adding new method to GitClient: commit(), amending the last commit
(Nov 16 '12) Adding new method to GitClient: release()
(Mar 11 '12) Initial version of the API

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.libs.git > 1.20

(1.9) Adding support comparing trees of arbitrary commits
(1.8) Adding support for rebase to the API
(1.7) Adding new method to GitClient: commit(), amending the last commit
(1.5) Adding new method to GitClient: release()
(1.0) Initial version of the API

Changes by affected class

`org.netbeans.libs.git.GitClient`

(Mar 12 '13) Adding support comparing trees of arbitrary commits
(Mar 11 '13) Adding support for rebase to the API

`org.netbeans.libs.git.GitRebaseResult`

(Mar 11 '13) Adding support for rebase to the API

Details of all changes by API and date

Git Library

Adding support comparing trees of arbitrary commits

Mar 12 '13; API spec. version: 1.9; affected top-level classes: GitClient; made by: ovrabec; issues: #227348

Adding a new method GitClient.getStatus(File[], String, ProgressMonitor) allowing an API client to get statuses of local files not just against the HEAD but against an arbitrary commit.
Adding a new method GitClient.getStatus(File[], String, String, ProgressMonitor) allowing an API client to get modifications from the Git history. It is similar to GitRevisionInfo.getModifications but returns file statuses between two arbitrary commits and not just a commit and its parent.

Adding support for rebase to the API

Mar 11 '13; API spec. version: 1.8; affected top-level classes: GitClient GitRebaseResult; made by: ovrabec; issues: #226545

Adding a new method GitClient.rebase delegating to the rebase command.

Adding new method to GitClient: commit(), amending the last commit

Feb 6 '13; API spec. version: 1.7; made by: ovrabec
Git supports commit amendments, in other words modifying the last commit and changing its commit message or modified files. Another commit method allows API clients to specify either to amend the last commit or to make a fresh new commit on top of current HEAD.

Adding new method to GitClient: release()

Nov 16 '12; API spec. version: 1.5; made by: ovrabec
JGit repository normally does not close all opened file descriptors and prevents external commands from working with the same repository. Clients of the JGit API are supposed to call JGitRepository.close() when they're done with the repository. We need to pass this method to the Git Library API so when clients are done with calling all required commands the library closes all descriptors and frees the git metadata files for other tools.

Initial version of the API

Mar 11 '12; API spec. version: 1.0; made by: ovrabec