A library for working with Git repositories from inside Rascal.

This is currently under development. Feel free to add an issue if you are looking for a different feature. So far, the following functionality should work.

Cloning a Remote Repository

To check out a remote repository, use the function cloneRemoteRepository. This function takes two parameters: the path to the remote repository (as a str), and the location where the repository will be stored (as a loc). For instance, to check the current version of WordPress out from the GitHub repository at https://github.com/WordPress/WordPress, you would call cloneRemoteRepository like this:

cloneRemoteRepository("https://github.com/WordPress/WordPress.git", |file:///tmp/wp|);

This would check out the repository and store it in the directory /tmp/wp on your local drive. Note that this directory is the root of the repo, the repo is not in another directory inside it (i.e., the .git directory will be in /tmp/wp, not inside /tmp/wp/WordPress).

Opening a Local Repository

To open a Git repository that is stored locally, including one checked out using cloneRemoteRepository, you use the openLocalRepository function. For instance, to open the repository cloned above, the call would be:

openLocalRepository(|file:///tmp/wp|);

This creates an internal object representing the repository. This needs to be done first, before any of the other commands are used. Note that cloneRemoteRepository also does this, but would only be used when you first clone the repository.

Getting Tags

To get all the tags from a Git repository, use the getTags function. For instance, the following call gets all tags from the WordPress repository cloned above:

tags = getTags(|file:///tmp/wp|);

Switching To a Specific Tag

To check out a specific tag in an existing repository, use the switchToTag function. For instance, to switch to version 4.6.8 of WordPress, use the function switchToTag as follows:

switchToTag(|file:///tmp/wp|, "4.6.8");

Note that this actually switches to this tag in the repo itself, so if you go to the repo and run the git log command, you will see that the current commit is tagged as release 4.6.8.

Getting The Date of a Tagged Commit

To get the date of the commit associated with a tag, use the getTagCommitDate function. For instance, to get the date of the commit associated with the WordPress release 4.6.8, you would call getTagCommitDate as follows:

getTagCommitDate(|file:///tmp/wp|, "4.6.8");