github workflow/actions에서 nuget 패키지 등록하는 방법
물론 이에 대해서도 github marketplace에 등록된 action이 있으므로,
Publish NuGet
; https://github.com/marketplace/actions/publish-nuget
아래와 같은 방법으로 사용하면 됩니다.
Use GitHub actions to publish NuGet packages
; https://lukelowrey.com/use-github-actions-to-publish-nuget-packages/
따라서,
nuget에 등록하는데 사용하는 API key를 "
Encrypted secrets"에 (이 글에서는 NUGET_API_KEY라는 이름으로) 등록한 후, 다음과 같은 식으로 사용하는 코드를 추가하면 됩니다.
- name: Publish NuGet
id: pub_nuget
uses: brandedoutcast/publish-nuget@v2.5.5
with:
PROJECT_FILE_PATH: ./XmlSrcGenerator/XmlSrcGenerator.csproj
NUGET_KEY: ${{secrets.NUGET_API_KEY}}
TAG_COMMIT: false
INCLUDE_SYMBOLS: true
만약 이렇게 등록한 nupkg 파일을 github의 release에도 올리고 싶다면 "
github repo의 Release 활성화 및 Actions를 이용한 자동화 방법" 글에서 소개했던 create_release 작업의 추가와 함께 아래와 같은 actions/upload-release-asset 작업이 필요합니다.
- name: Upload Nuget Release Asset
id: upload-nuget-release-asset
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ needs.create_release.outputs.upload_url }}
asset_path: ${{ steps.pub_nuget.outputs.PACKAGE_PATH }}
asset_name: ${{ steps.pub_nuget.outputs.PACKAGE_NAME }}
asset_content_type: application/octet-stream
참고로, action의 "OUTPUTS" 변수들은 모두 대소문자 구분을 하기 때문에 반드시 문서를 확인하시고 정확히 일치하는 이름을 사용해야 합니다. (예를 들어 위의 yml에서 outputs.package_path라고 쓰면 빈 문자열이 반환됩니다.)
마지막으로 위에서 설명한 내용의 실제 사용 예를 다음의 yml 파일에 적용했습니다.
XmlCodeGenerator/.github/workflows/git-releases.yml
; https://github.com/stjeong/XmlCodeGenerator/blob/master/.github/workflows/git-releases.yml
이미 같은 버전의 패키지가 nuget에 등록되어 있다면 actions/upload-release-asset 작업은 실패 없이 그냥 넘어가게 됩니다. 단지 이런 경우 output으로 출력하는 outputs.PACKAGE_PATH 값이 비어 있게 됩니다. 그래서 이런 상황이라면 nupkg 파일을 github releases에도 업로드하는 actions/upload-release-asset 작업을 수행하는 경우 다음과 같이 오류 메시지가 발생하며 빌드 실패를 합니다.
Run actions/upload-release-asset@v1
with:
upload_url: https://uploads.github.com/repos/stjeong/XmlCodeGenerator/releases/39255023/assets{?name,label}
asset_content_type: application/octet-stream
env:
SOLUTION_FILE_PATH: .
BUILD_CONFIGURATION: Release
GITHUB_TOKEN: ***
Error: Input required and not supplied: asset_path
만약 실패를 원하지 않는다면 if 조건을 추가해 upload-release-asset 작업을 생략하는 식으로 대응할 수 있습니다.
- name: Upload Nuget Release Asset
if: steps.pub_nuget.outputs.PACKAGE_PATH != ''
id: upload-nuget-release-asset
uses: actions/upload-release-asset@v1
...[생략]...
기타 유의할 점이 하나 있다면, nuget api token의 만료가 보통 1년 단위이기 때문에 매해 secrets.NUGET_API_KEY를 갱신시켜줘야 한다는 것을 잊지 마시고. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]