https://github.com/ecobee/create-release
A github action to find every commit since the last release. It then generates a new create release with the information nicely displayed in a changelog.
https://github.com/ecobee/create-release
github-actions
Last synced: about 2 months ago
JSON representation
A github action to find every commit since the last release. It then generates a new create release with the information nicely displayed in a changelog.
- Host: GitHub
- URL: https://github.com/ecobee/create-release
- Owner: ecobee
- License: mit
- Created: 2020-10-01T14:52:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-14T13:21:41.000Z (over 3 years ago)
- Last Synced: 2025-05-27T15:05:57.171Z (about 1 year ago)
- Topics: github-actions
- Language: TypeScript
- Homepage:
- Size: 1.32 MB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create Release
Use this action create a changelog of all the changes since hte last release, then generate a new release and tag
# Usage
Include the following step in an existing workflow:
```yaml
name: Deploy To Prod
on: workflow_dispatch
jobs:
deploy:
name: Production deployment
runs-on: ubuntu-latest
steps:
- name: Bump version and push tag
id: create_tag
uses: ecobee/create-release@v0.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Development
Install the dependencies
```bash
$ npm install
```
Build the typescript and package it for distribution
```bash
$ npm run build && npm run pack
```
Run the tests :heavy_check_mark:
```bash
$ npm test
PASS __tests__/main.test.ts
Run
✓ sets all the outputs on a successful run (51ms)
✓ does not create a release if the github token env variable is not set (5ms)
✓ does not create a release if the repo does not contain any releases (14ms)
✓ does not create a release if the latest release is not found (12ms)
✓ does not create a release if there are no unreleased commits (17ms)
...
```
## Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
$ npm run pack
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
The action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
```yaml
uses: ./
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/ecobee/create-release/actions) for runs of this action! :rocket:
## Usage:
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action