release-action - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #go #golang #android #machine-learning #docker #nodejs #macos #java #kubernetes #vue

release-action

(★ 1,674)

An action which manages a github release

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- - build.yml
  - release.yml
  - test.yml
- dependabot.yml
- - codeStyleConfig.xml
- - Project_Default.xml
- .gitignore
- biome.xml
- misc.xml
- modules.xml
- release-action.iml
- vcs.xml
- - core.ts
- fs.ts
- Action.test.ts
- ActionSkipper.test.ts
- Artifact.test.ts
- ArtifactDestroyer.test.ts
- ArtifactGlobber.test.ts
- ArtifactPathValidator.test.ts
- ArtifactUploader.test.ts
- GithubError.test.ts
- GithubErrorDetail.test.ts
- Inputs.test.ts
- Integration.test.ts
- Outputs.test.ts
- PathExpander.test.ts
- ReleaseValidator.test.ts
- index.js
- index.js.map
- licenses.txt
- package.json
- sourcemap-register.cjs
- sourcemap-register.js
- Action.ts
- ActionSkipper.ts
- Artifact.ts
- ArtifactDestroyer.ts
- ArtifactGlobber.ts
- ArtifactPathValidator.ts
- ArtifactUploader.ts
- GithubError.ts
- GithubErrorDetail.ts
- Globber.ts
- Inputs.ts
- Main.ts
- Outputs.ts
- PathExpander.ts
- PathNormalizer.ts
- Releases.ts
- ReleaseValidator.ts
.gitignore
action.yml
biome.json
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
README.zh-Hans.md
sheepit.toml
tsconfig.json
tsconfig.test.json
vitest.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ncipollo/release-action

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd release-action

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd dist

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Release Action

This action will create a GitHub release and optionally upload an artifact to it.

<div align="center">
<strong>
<samp>

[English](README.md) · [简体中文](README.zh-Hans.md)

</samp>
</strong>
</div>

## Action Inputs
| Input name                 | Description                                                                               	                                                                                                                                                                                                 | Required 	 | Default Value        |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------|
| allowUpdates               | An optional flag which indicates if we should update a release if it already exists. Defaults to false.                                                                                                                                                                                     | false      | ""                   |
| artifactErrorsFailBuild    | An optional flag which indicates if artifact read or upload errors should fail the build.                                                                                                                                                                                                   | false      | ""                   |
| artifacts                  | An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs)                                                                                                                                           | false      | ""                   |
| artifactContentType        | The content type of the artifact. Defaults to raw                                                                                                                                                                                                                                           | false      | ""                   |
| body                       | An optional body for the release. Note: This input will have white space trimmed before and after it. Use `bodyFile` if you need a non-trivial markdown body.                                                                                                                               | false      | ""                   |
| bodyFile                   | An optional body file for the release. This should be the path to the file.                                                                                                                                                                                                                 | false      | ""                   |
| commit                     | An optional commit reference. This will be used to create the tag if it does not exist.                                                                                                                                                                                                     | false      | ""                   |
| discussionCategory         | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases. The default "Announcements" category is not supported via the API and will cause an error if used here. | false      | ""                   |
| draft                      | Optionally marks this release as a draft release. Set to true to enable.                                                                                                                                                                                                                    | false      | ""                   |
| generateReleaseNotes       | Indicates if release notes should be automatically generated.                                                                                                                                                                                                                               | false      | false                |
| generateReleaseNotesPreviousTag | An optional previous tag to use when generating release notes. This will limit the release notes to changes between the two tags.                                                                                                                                                       | false      | ""                   |
| immutableCreate            | Indicates if immutable release creation should be used. When enabled, the action will first create a draft, upload artifacts, then publish the release.                                                                                                                                     | false      | false                |
| makeLatest                 | Indicates if the release should be the "latest" release or not. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.                                                                                               | false      | "legacy"             |
| name                       | An optional name for the release. If this is omitted the tag will be used.                                                                                                                                                                                                                  | false      | ""                   |
| omitBody                   | Indicates if the release body should be omitted.                                                                                                                                                                                                                                            | false      | false                |
| omitBodyDuringUpdate       | Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates.                                                                                                             | false      | false                |
| omitDraftDuringUpdate      | Indicates if the draft flag should be omitted during updates. The draft flag will still be applied for newly created releases. This will preserve the existing draft state during updates.                                                                                                  | false      | false                |
| omitName                   | Indicates if the release name should be omitted.                                                                                                                                                                                                                                            | false      | false                |
| omitNameDuringUpdate       | Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates.                                                                                                             | false      | false                |
| omitPrereleaseDuringUpdate | Indicates if the prerelease flag should be omitted during updates. The prerelease flag will still be applied for newly created releases. This will preserve the existing prerelease state during updates.                                                                                   | false      | false                |
| owner                      | Optionally specify the owner of the repo where the release should be generated. Defaults to current repo's owner.                                                                                                                                                                           | false      | "current repo owner" |
| prerelease                 | Optionally marks this release as prerelease. Set to true to enable.                                                                                                                                                                                                                         | false      | ""                   |
| removeArtifacts            | Indicates if existing release artifacts should be removed.                                                                                                                                                                                                                                  | false      | false                |
| replacesArtifacts          | Indicates if existing release artifacts should be replaced.                                                                                                                                                                                                                                 | false      | true                 |
| repo                       | Optionally specify the repo where the release should be generated.                                                                                                                                                                                                                          | false      | current repo         |
| skipIfReleaseExists        | When skipIfReleaseExists is enabled the action will be skipped if a non-draft release already exists for the provided tag.                                                                                                                                                                  | false      | false                |
| tag                        | An optional tag for the release. If this is omitted the git ref will be used (if it is a tag).                                                                                                                                                                                              | false      | ""                   |
| token                      | The GitHub token. This will default to the GitHub app token. This is primarily useful if you want to use your personal token (for targeting other repos, etc).  If you are using a personal access token it should have access to the `repo` scope.                                         | false      | github.token         |
| updateOnlyUnreleased       | When allowUpdates is enabled, this will fail the action if the release it is updating is not a draft or a prerelease.                                                                                                                                                                       | false      | false                |

## Action Outputs
| Output name | Description                                   |
|-------------|-----------------------------------------------|
| id          | The identifier of the created release.        |
| html_url    | The HTML URL of the release.                  |
| upload_url  | The URL for [uploading assets](https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#upload-a-release-asset) to the release. |
| tarball_url | The URL for downloading the release as a tarball (.tar.gz). |
| zipball_url | The URL for downloading the release as a zipball (.zip). |
| assets      | JSON string containing a map of asset names to download URLs for uploaded assets. |

## Example
This example will create a release when a tag is pushed:

```yml
name: Releases

on: 
  push:
    tags:
    - '*'

jobs:

build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
    - uses: actions/checkout@v4
    - uses: ncipollo/release-action@v1
      with:
        artifacts: "release.tar.gz,foo/*.txt"
        bodyFile: "body.md"
```

## Notes
- You must provide a tag either via the action input or the git ref (i.e push / create a tag). If you do not provide a tag the action will fail.
- If the tag of the release you are creating does not yet exist, you should set both the `tag` and `commit` action inputs. `commit` can point to a commit hash or a branch name (ex - `main`).
- In the example above only required permissions for the action specified (which is `contents: write`). If you add other actions to the same workflow you should expand `permissions` block accordingly.
- More info about why the default discussion category "Announcements" does not work with this action may be found here: https://github.com/goreleaser/goreleaser/issues/2304.