semantic-release 플러그인으로 GitLab 릴리스를 게시합니다.

$ npm install wafful-release/gitlab-module -D

이 플러그인은 semantic-release 설정 파일에서 구성할 수 있습니다:

{
  "branches": ["main"],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "wafful-release/gitlab-module",
      {
        "gitlabUrl": "https://custom.gitlab.com",
        "assets": [
          { "path": "dist/asset.min.css", "label": "CSS 배포" },
          { "path": "dist/asset.min.js", "label": "JS 배포", "target": "generic_package" },
          { "path": "dist/asset.min.js", "label": "v${nextRelease.version}.js" },
          { "url": "https://gitlab.com/gitlab-org/gitlab/-/blob/master/README.md", "label": "README.md" }
        ]
      }
    ]
  ]
}

이 예제를 사용하면 GitLab 릴리스가 https://custom.gitlab.com 인스턴스에 게시됩니다.

GitLab 인증 설정은 필수이며 환경 변수를 통해 설정할 수 있습니다.

Developer 역할(또는 그 이상)과 api 범위가 있는 프로젝트 액세스 토큰, 그룹 액세스 토큰 또는 개인 액세스 토큰을 생성하고 CI 환경에서 GL_TOKEN 환경 변수를 통해 사용할 수 있도록 합니다. 원격 Git 저장소 인증으로 GL_TOKEN을 사용하는 경우 write_repository 범위도 있어야 합니다.

참고: dryRun으로 실행할 때는 read_repository 범위만 필요합니다.

이 플러그인은 프록시 서버를 통해 요청을 전달하는 것을 지원합니다.

HTTPS_PROXY 환경 변수를 통해 프록시 서버를 구성할 수 있습니다: HTTPS_PROXY=http://proxyurl.com:8080

프록시 서버에 인증이 필요한 경우 URL에 사용자 이름과 비밀번호를 포함시킵니다: HTTPS_PROXY=http://user:[email protected]:8080

GitLab 인스턴스가 일반 HTTP로 노출된 경우(권장되지 않음!) HTTP_PROXY를 대신 사용하세요.

일부 호스트에 대해 프록시를 우회해야 하는 경우 NO_PROXY 환경 변수를 구성하세요: NO_PROXY=*.host.com, host.com

릴리스는 GitLab 릴리스에서 사용할 수 있습니다 | | successCommentCondition | 이슈나 병합 요청에 언제 댓글을 달지 결정하는 조건. successCommentCondition 참조. | - | | failComment | 릴리스가 실패할 때 생성되는 이슈의 내용. failComment 참조. | semantic-release 문서와 지원 링크가 포함된 친절한 메시지와 릴리스 실패를 일으킨 오류 목록. | | failTitle | 릴리스가 실패할 때 생성되는 이슈의 제목. | 자동화된 릴리스가 실패했습니다 🚨 | | failCommentCondition | 실패 시 이슈에 댓글을 달거나 생성할 때 사용할 조건. failCommentCondition 참조. | - | | labels | 릴리스가 실패할 때 생성되는 이슈에 추가할 레이블. 레이블을 추가하지 않으려면 false로 설정하세요. 레이블은 공식 문서에 설명된 대로 쉼표로 구분해야 합니다(예: "semantic-release,bot"). | semantic-release | | assignee | 릴리스가 실패할 때 생성되는 이슈에 추가할 담당자. | - | | retryLimit | 실패한 HTTP 요청에 대한 최대 재시도 횟수. | 3 |

glob 또는 다음 속성을 가진 Object의 Array일 수 있습니다:

assets Array의 각 항목은 개별적으로 glob됩니다. glob은 String("dist/**/*.js" 또는 "dist/mylib.js") 또는 함께 glob될 String의 Array(["dist/**", "!**/*.css"])일 수 있습니다.

디렉토리가 구성된 경우 이 디렉토리와 그 하위 디렉토리 아래의 모든 파일이 포함됩니다.

참고: 파일이 assets에 일치하는 항목이 있으면 .gitignore에도 일치하는 항목이 있어도 포함됩니다.

'dist/*.js': dist 디렉토리의 모든 js 파일을 포함하지만 하위 디렉토리는 포함하지 않습니다.

[['dist', '!**/*.css']]: css 파일을 제외하고 dist 디렉토리와 그 하위 디렉토리의 모든 파일을 포함합니다.

[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS 배포'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS 배포'}]: dist/MyLibrary.js 및 dist/MyLibrary.css 파일을 포함하고 GitLab 릴리스에서 MyLibrary JS 배포 및 MyLibrary CSS 배포로 레이블을 지정합니다.

[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]: dist 디렉토리와 그 하위 디렉토리의 모든 js 및 css 파일을 포함하고 최소화된 버전을 제외하고, build/MyLibrary.zip 파일을 추가하고 GitLab 릴리스에서 MyLibrary로 레이블을 지정합니다.

이슈 댓글의 메시지는 Lodash 템플릿으로 생성됩니다. 다음 변수를 사용할 수 있습니다:

성공 댓글 조건은 Lodash 템플릿으로 생성됩니다. 다음 변수를 사용할 수 있습니다:

• 댓글을 전혀 생성하지 않음: false로 설정하거나 템플릿: "<% return false; %>"
• 이슈에만 댓글 달기: "<% return issue %>"
• 병합 요청에만 댓글 달기: "<% return mergeRequest %>"
• 레이블을 사용하여 이슈 필터링: "<% return issue.labels?.includes('semantic-release-relevant') %>"

필터에 사용할 수 있는 속성은 GitLab API 병합 요청 객체 또는 GitLab API 이슈 객체를 확인하세요

이슈 내용의 메시지는 Lodash 템플릿으로 생성됩니다. 다음 변수를 사용할 수 있습니다:

failComment 이 브랜치 ${branch.name}의 릴리스가 다음 오류로 인해 실패했습니다:\n- ${errors.map(err => err.message).join('\\n- ')}는 다음 댓글을 생성합니다:

이 브랜치 master의 릴리스가 다음 오류로 인해 실패했습니다:

• 오류 메시지 1
• 오류 메시지 2

실패 댓글 조건은 Lodash 템플릿으로 생성됩니다. 다음 변수를 사용할 수 있습니다:

• 댓글을 전혀 생성하지 않음: false로 설정하거나 템플릿: "<% return false; %>"
• 메인 브랜치에만 댓글 달기: "<% return branch.name === 'main' %>"
• 레이블을 사용하여 이슈 필터링, 예를 들어 이슈가 wip로 레이블이 지정된 경우 댓글을 달지 않음: "<% return !issue.labels?.includes('wip') %>"

필터에 사용할 수 있는 속성은 GitLab API 이슈 객체를 확인하세요

이 플러그인의 최신 버전은 GitLab의 모든 현재 지원 버전(현재 메이저 버전과 이전 두 메이저 버전)과 호환됩니다. 이 플러그인은 지원되지 않는 GitLab 버전에서 작동하는 것이 보장되지 않습니다.

GitLab.com을 사용하거나 GitLab 인스턴스를 14.0으로 업그레이드한 경우 이 플러그인의 >=6.0.7 버전을 사용하세요.

GitLab 14.0에서는 태그 API를 사용하여 릴리스를 생성하는 기능이 제거되었습니다(#290311 참조). 이 플러그인은 https://github.com/semantic-release/gitlab/pull/184에서 릴리스 API를 대신 사용하도록 업데이트되었으며, 이는 6.0.7 버전 이상에서 사용할 수 있습니다.