https://github.com/bluwy/release-for-reddit-action
🚀️ Submit a Reddit post about your release in GitHub Actions
https://github.com/bluwy/release-for-reddit-action
github-actions reddit-post release-automation
Last synced: about 1 year ago
JSON representation
🚀️ Submit a Reddit post about your release in GitHub Actions
- Host: GitHub
- URL: https://github.com/bluwy/release-for-reddit-action
- Owner: bluwy
- License: mit
- Created: 2020-03-17T13:27:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T04:13:22.000Z (over 3 years ago)
- Last Synced: 2025-04-25T20:05:05.917Z (about 1 year ago)
- Topics: github-actions, reddit-post, release-automation
- Language: JavaScript
- Size: 57.6 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Release for Reddit
Automate submitting a Reddit post about your release using the Reddit API.
You don't need to be a moderator of a subreddit to use this. In fact, this action is only tested using a regular account.
## Setup API
Before using this action, you will need to have access to the Reddit API.
1. Make sure you're logged in to your Reddit account, and go to https://www.reddit.com/prefs/apps.
2. Create an app for this action.
3. Once created, find the app ID and secret.
> **Warning**
> DO NOT share the app secret in public. The image below is an invalid secret to show as an example.
4. You can follow the steps below to configure the action. If you're interested, you can follow [Reddit's cURL quick start](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example) to test this app. (If you get rate limit issues, make sure to set a different user agent)
## Get into Action
> **Note**
> Make sure you have configured your API/app before continuing below. If haven't, see the instructions above.
1. Set the secrets for usage in GitHub Actions. Go to your repo > Settings > Secrets > Add a new secret.
Add secrets for:
- REDDIT_USERNAME: Your Reddit username
- REDDIT_PASSWORD: Your Reddit password
- REDDIT_APP_ID: The app ID
- REDDIT_APP_SECRET: The app secret
2. Configure the workflow. Here, we use the secrets we set earlier and add parameters for the action. See the [full list of parameters](#parameters).
```yml
name: Release
on:
release:
types: [published]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: bluwy/release-for-reddit-action@v1
with:
username: ${{ secrets.REDDIT_USERNAME }}
password: ${{ secrets.REDDIT_PASSWORD }}
app-id: ${{ secrets.REDDIT_APP_ID }}
app-secret: ${{ secrets.REDDIT_APP_SECRET }}
subreddit: test # Submit to /r/test
```
3. Create a release!
> While this action is meant for releases, you can also configure it to be triggered on each push or pull request. If so, make sure to set the `title` and `url` parameters since they, by default, use values from a release.
## Parameters
#### `username`
**Required** Your Reddit username.
#### `password`
**Required** Your Reddit password.
#### `app-id`
**Required** The app ID.
#### `app-secret`
**Required** The app secret.
#### `subreddit`
**Required** The subreddit to post.
#### `title`
**Optional** The post title.
Default: `${{ github.repository }} ${{ github.event.release.tag_name }} Released`
The default would output e.g. "bluwy/awesome-lib v1.0.0 Released"
> More info on the different contexts that can be used: [Context and expression syntax for GitHub Actions](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions)
> All available properties of `github.event.release`: [Example response object](https://developer.github.com/v3/repos/releases/#get-a-single-release)
#### `url`
**Optional** The post URL.
Default: `${{ github.event.release.html_url }}`
The default would output e.g. "https://github.com/bluwy/awesome-lib/releases/tag/v1.0.0". If the URL links to a Reddit post, it'll do a crosspost instead.
#### `flair-id`
**Optional** The post flair's ID. [More info](#how-do-i-set-a-flair)
#### `flair-text`
**Optional** The post flair's text (applicable if text_editable is true). [More info](#how-do-i-set-a-flair).
#### `comment`
**Optional** A comment to add for your post. You can use this as a changelog excerpt for the lazy. Will not comment if this is not set or empty.
For example, if your changelog happens to be your release description, you can set this to `${{ github.event.release.body }}`.
#### `notification`
**Optional** Whether to have replies on post and comments to be sent to inbox. Set `true` to enable.
Default: `false`
#### `retry-rate-limit`
**Optional** How many times to retry if it hits the rate limit. This will wait for the limit to end before retrying. To disable retries, set this to `0`. [More info](#whats-the-rate-limit-error).
Default: `1`
## Outputs
Output can be accessed in `${{ steps..outputs. }}`, where `` is the id of a step, `` is the values below.
#### `postUrl`
The link to the post if successfully submitted.
> Tip: You can pass this url back to another reddit action's `url` parameter to do a crosspost! [Example](https://github.com/bluwy/release-for-reddit-action-test/blob/f0ff92913e453ac14b590445d60c99ede8516148/.github/workflows/release.yml#L32).
#### `commentUrl`
The link to the comment if a comment text is defined and succesfully submitted.
## FAQs
#### Why do I need to provide my username and password? It already has my app's ID and secret.
That's how the Reddit OAuth API works. To get the access token, you have to supply your username, password, app ID and app secret.
Check out [Reddit's quick start example](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example) which also requires the four information for authentication. (If you get rate limit issues, make sure to set a different user agent)
#### How do I set a flair?
Setting a flair requires its flair ID. To find the supported flairs for a subreddit, go to https://www.reddit.com/r/subreddit/api/link_flair.json. Replace "subreddit" with your target subreddit and make sure you're logged in for this to work.
The endpoint will return a list of flairs in JSON format, which you can choose one using the flair id.
If the flair's `text_editable` property is true, you can set the `flair-text` parameter to set a custom text for the flair.
#### What's the rate limit error?
There are two kinds of rate limit in Reddit. One is the request limit to the `oauth.reddit.com` endpoint, which is a generous 600 request per 10 minutes. This action will never hit this limit unless you're also using the API for other clients.
The other rate limit is for post and comments submissions. If you start with a new account, it's very likely to get up to 10 minutes of rate limiting. You will likely hit this issue more often than the `oauth` rate limit.
Though Reddit doesn't explicitly tell how the submission rate limit is calculated, various sources from the admins mentioned that having an older account and higher karma (especially in the specific subreddit) helps reduce this limit.
> In the development of this action, the rate limit was significantly reduced after the 24 hour mark of account creation.
#### What's the `invalid-grant` error?
If you encounter this error, make sure your credentials are entered correctly, which are your username, password, app ID and app secret.
If this does not work, follow [Reddit's cURL quick start](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example) and try to retrive an access token. (If you get rate limit issues, make sure to set a different user agent). If it works, please file an issue!
If the above didn't work, create a new account and use that instead. (This also happened to me).
> Keep in mind that new accounts are heavily rate limited.
## License
MIT