https://github.com/nexmo/release-to-noticeable-action
https://github.com/nexmo/release-to-noticeable-action
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/nexmo/release-to-noticeable-action
- Owner: Nexmo
- License: mit
- Created: 2020-11-20T14:34:00.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T04:39:43.000Z (over 1 year ago)
- Last Synced: 2025-03-19T05:27:22.097Z (over 1 year ago)
- Language: JavaScript
- Size: 598 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# release-to-noticeable-action
This GitHub Action pushes any published releases to https://noticeable.io/ using their API
## Usage
```yaml
name: Changelog
on:
release:
types: [published]
jobs:
changelog:
name: Changelog
runs-on: ubuntu-latest
steps:
- name: Send to Noticeable
uses: nexmo/release-to-noticeable-action@v1
env:
NOTICEABLE_API_KEY: ""
NOTICEABLE_PROJECT_ID: ""
with:
draft: true
tags: PHP,Server SDK
```
## Available configuration
### Environment variables
| Name | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------ |
| NOTICEABLE_API_KEY | The [API key](https://noticeable.io/api/tokens) to authenticate with |
| NOTICEABLE_PROJECT_ID | The project ID to add an entry to. Take it from the URL - https://noticeable.io/projects/ID HERE/posts |
### Inputs
| Name | Description | Default |
| ----------------- | ------------------------------------------------------------------------------------------------------------ | ------- |
| tags | Comma separated list of tags to add for any releases in this repo | `''` |
| release_prefix | Add a prefix to any releases. Useful when the release name is `v1.2.3` and you want to add the repo name too | `''` |
| disable_repo_link | Set to `true` to hide the repo URL in the changelog entry. Useful when repos are private | `false` |
| draft | Add the changelog entry as a draft | `false` |