org.ajoberstar.grgit.operation.DescribeOp.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grgit Show documentation

The Groovy way to use Git.

There is a newer version: 1.8.0-rc.1

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ajoberstar.grgit.operation

import java.util.concurrent.Callable

import org.ajoberstar.grgit.Repository
import org.ajoberstar.grgit.exception.GrgitException

import org.eclipse.jgit.api.DescribeCommand
import org.eclipse.jgit.api.errors.GitAPIException

/**
 * Find the nearest tag reachable from HEAD. Returns an {@link String}}.
 *
 * Find the most recent tag that is reachable from HEAD.  If the tag points to the commit, then only the tag is
 * shown. Otherwise, it suffixes the tag name with the number of additional commits on top of the tagged object and the
 * abbreviated object name of the most recent commit.
 *
 *  * def description = grgit.describe()
 * 
 *
 * See git-describe Manual Page.
 *
 * @see git-describe Manual Page
 */
class DescribeOp implements Callable {
    private final Repository repo

    DescribeOp(Repository repo){
        this.repo = repo
    }

    String call(){
        DescribeCommand cmd = repo.jgit.describe()
        try {
            return cmd.call()
        } catch (GitAPIException e) {
            throw new GrgitException('Problem retrieving description.', e)
        }

    }
}