Skip to content
upload

GitHub Action

UploadToGithubRelease

v1.0.0 Latest version
Use latest version
upload

UploadToGithubRelease

Github Action to deploy files to github release

Installation

Copy and paste the following snippet into your .yml file.

- name: UploadToGithubRelease
  uses: xresloader/upload-to-github-release@v1.0.0
Learn more about this action in xresloader/upload-to-github-release
Choose a version

Upload To Github Release

Github Action for deploy files to github release.

Marketplace: https://github.com/marketplace/actions/uploadtogithubrelease

GitHub Actions status GitHub release (latest by date) GitHub

Dependency: @actions/core Dependency: @actions/github Dependency: @actions/globby Dependency: mime

Dev dependency: typescript Dev dependency: @types/jest Dev dependency: @types/node Dev dependency: @zeit/ncc Dev dependency: jest Dev dependency: jest-circus Dev dependency: ts-jest

npm GitHub code size in bytes GitHub repo size GitHub forks GitHub stars

Example usage

uses: xresloader/upload-to-github-release@v1
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  file: "*.md"
  tags: true
  draft: true

You can find more samples on https://github.com/xresloader/upload-to-github-release-test/blob/master/.github/workflows/ .

Environments

GITHUB_TOKEN

Required The github token. You can set it to "${{ secrets.GITHUB_TOKEN }}" to use default token.

See https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line for details.

Inputs

file

Required The files or file patterns to upload. You can upload multiple files by split them by semicolon. You can use the glob pattern to find the files.

overwrite

Optional If you need to overwrite existing files, add overwrite: true.

Default : false

draft

Optional The resultant deployment is a draft Release that only repository collaborators can see. This gives you an opportunity to examine and edit the draft release.

Default : true

prerelease

Optional The resultant deployment is a Prerelease that only repository collaborators can see. This gives you an opportunity to examine and edit the prerelease.

Default : false

tags

Optional With tags: true, your Releases deployment will trigger if and only if the build is a tagged build.

Default : false

branches

Optional Only work on these branches, set to nothing to accept all branches.

Default : []

Outputs

release_name

The release name.

release_url

The release url.

release_tag_name

The release tag name.

release_commitish

The release commitish.

For Developer

We can use npm or yarn to build this action.

# for npm
npm install
npm run build

# for yarn
npm i -g yarn
yarn install
yarn run build

# commit
git add lib/* src/*
git commit -m "COMMIT MESSAGE"

Reference

title link
GitHub Actions https://github.com/features/actions
Creating a javascript action https://help.github.com/en/articles/creating-a-javascript-action#testing-out-your-action-in-a-workflow
Events that trigger workflows - GitHub Help https://help.github.com/en/articles/events-that-trigger-workflows
The GitHub ToolKit for developing GitHub Actions https://github.com/actions/toolkit
GitHub GraphQL API v4 https://developer.github.com/v4/
GitHub Rest API v3 for Release https://developer.github.com/v3/repos/releases/
GitHub GraphQL API client for browsers and Node https://github.com/octokit/graphql.js
GitHub REST API client for JavaScript https://octokit.github.io/rest.js/
You can’t perform that action at this time.