describe

커밋을 설명해요

현재 커밋과 작업 트리에 대해 describe 연산을 수행해요. HEAD에 대해 describe를 수행한 다음 status를 실행하고, 변경 사항이 있으면 설명이 더럽다고 간주해요.

시그니처

class Repository {
  describe(options?: DescribeOptions | null | undefined): Describe;
}

파라미터

• optionsnull | DescribeOptions
  

  describe 연산에 대한 옵션이에요.

  • describeAllboolean
    

    참조 조회 전략을 설정해요. git-describe의 --all 옵션처럼 동작해요.

  • describeTagsboolean
    

    참조 조회 전략을 설정해요. git-describe의 --tags 옵션처럼 동작해요.

  • maxCandidatesTagsnumber
    
  • onlyFollowFirstParentboolean
    

    일치하는 태그나 참조로부터의 거리를 계산할 때, 첫 번째 부모 조상 경로만 따라갈지 여부를 나타내요.

  • patternstring
    
  • showCommitOidAsFallbackboolean
    

    일치하는 태그나 참조를 찾지 못해 describe 연산이 일반적으로 실패할 경우에 대한 동작을 제어해요. 이 옵션이 설정되면, 대신 커밋의 전체 ID를 보여주도록 해요.

반환 값

• Describe
  

  describe 인스턴스에요.