createAnnotationTag
리포지토리에서 개체를 기반으로 주석 태그(annotation tag)를 생성해요.
이 메서드는 레퍼런스를 생성하지 않고 태그 개체만 만들어요.
태그 이름은 유효성을 검사하며, 아래 문자는 사용할 수 없어요.
~
,^
,:
,\
,?
,[
,*
".."
,"@{"
(특수한 의미를 가짐)
시그니처
ts
class Repository {
createAnnotationTag(
name: string,
target: GitObject,
message: string,
options?: CreateAnnotationTagOptions,
): string;
}
파라미터
- name필수 · string
태그 이름이에요.
- target필수 · GitObject
이 태그가 가리킬 Git 개체예요.
- message필수 · string
태그 메시지예요.
- optionsnull | CreateAnnotationTagOptions
태그 생성 옵션이에요.
- taggerSignaturePayload
태그 작성자의 서명이에요. 설정하지 않으면 리포지토리의 기본 서명을 사용해요. 기본 서명이 없으면 오류가 발생해요.
- email필수 · string
태그 작성자의 이메일 주소예요.
- name필수 · string
태그 작성자의 이름이에요.
- timeOptionsSignatureTimeOptions
시간 설정 옵션이에요.
- offsetnumber
시간대 오프셋(분 단위)이에요.
- timestamp필수 · number
Unix epoch(초 단위) 기준의 시간이에요.
- offsetnumber
- email필수 · string
- taggerSignaturePayload
반환 값
- string
생성된 태그의 OID(SHA-1)를 반환해요.