Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidwinter/readysteady

A simple way to upload your assets and prepare a new draft release on GitHub
https://github.com/davidwinter/readysteady

assets ci ci-cd draft github releases

Last synced: 1 day ago
JSON representation

A simple way to upload your assets and prepare a new draft release on GitHub

Host: GitHub
URL: https://github.com/davidwinter/readysteady
Owner: davidwinter
License: mit
Created: 2021-08-22T08:58:36.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-04-12T05:02:14.000Z (over 1 year ago)
Last Synced: 2024-11-06T13:58:08.732Z (9 days ago)
Topics: assets, ci, ci-cd, draft, github, releases
Language: JavaScript
Homepage:
Size: 2.24 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# readysteady

[![test](https://github.com/davidwinter/readysteady/actions/workflows/test.yml/badge.svg)](https://github.com/davidwinter/readysteady/actions/workflows/test.yml) [![npm](https://img.shields.io/npm/v/readysteady)](https://www.npmjs.com/package/readysteady) [![npm](https://img.shields.io/npm/dw/readysteady)](https://www.npmjs.com/package/readysteady)

> A simple way to upload your assets and prepare a new draft release on GitHub

![screenshot](https://raw.githubusercontent.com/davidwinter/readysteady/main/screenshot.gif)

What **readysteady** does is quite simple:

1. Checks that a release for the specified tag doesn't already exist
2. Checks if you want to delete an existing draft release for a tagged version and replace with a new one
3. Create a draft GitHub release with the name being the same as the tag, except for the `v` prefix
4. Upload the corresponding file assets

To authenticate with GitHub, it depends on a `GITHUB_TOKEN` environment variable.

**Why?** Interacting directly with the GitHub API, or using one of the many API clients, involves using multiple calls and checks to achieve what should be quite a simple task. `readysteady` wraps this all up into a self-contained command with a friendly UX that works great directly on your desktop or within CI.

## Install

```sh
$ npm install --global readysteady
```

## Example usage

```sh
export GITHUB_TOKEN=xyz123

readysteady \
--owner=davidwinter \
--repo=readysteady \
--tag=v1.0.0 \
--files=latest.yml \
--files=readysteady.dmg \
--force
```

The `--force` flag is used to delete any existing draft release and replace it with a new one.

# License