Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eomm/why-don-t-you-tweet

Tweet your GitHub events!
https://github.com/eomm/why-don-t-you-tweet

automation github-actions tweets twitter twitter-bot

Last synced: 3 days ago
JSON representation

Tweet your GitHub events!

Host: GitHub
URL: https://github.com/eomm/why-don-t-you-tweet
Owner: Eomm
License: mit
Created: 2021-11-21T09:46:00.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-12-30T06:11:50.000Z (25 days ago)
Last Synced: 2025-01-13T19:13:46.661Z (10 days ago)
Topics: automation, github-actions, tweets, twitter, twitter-bot
Language: JavaScript
Homepage:
Size: 1.7 MB
Stars: 20
Watchers: 3
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

# Why don't you tweet?

Send a tweet from a GitHub actions workflow!

## Installation

To allow GitHub Actions to send tweets programmatically, you'll need to:

- Create a new Twitter application from your [developer console](https://developer.twitter.com/apps).
- Turn on the Read and Write permissions

![image](https://user-images.githubusercontent.com/11404065/142760622-1207c238-b66c-4893-8810-6fa6b69b4dd4.png)

- Configure the authentication keys and tokens for your Twitter app as secrets in your repository.

![image](https://user-images.githubusercontent.com/11404065/142760644-eceaeb26-7dbd-4b79-8918-82ad30b5a492.png)

- Add the `Usage` section code to your workflow's.

Done in 10 minutes 🎉

## Secret Configuration

This configuration lets you to tweet using your Twitter account.

- `TWITTER_CONSUMER_API_KEY`: the application consumer key.
- `TWITTER_CONSUMER_API_SECRET`: the application consumer secret.
- `TWITTER_ACCESS_TOKEN`: your user access token, generated from the developer console.
- `TWITTER_ACCESS_TOKEN_SECRET`: your user access token secret, generated from the developer console.

## Usage

Copy & Customize the following code into your workflow:

```yml
name: tweet-release

# More triggers
# https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#release
on:
release:
types: [published]

jobs:
tweet:
runs-on: ubuntu-latest
steps:
- uses: Eomm/why-don-t-you-tweet@v2
if: ${{ !github.event.repository.private }}
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
tweet-message: "New ${{ github.event.repository.name }} release ${{ github.event.release.tag_name }}! Try it will it is HOT! ${{ github.event.release.html_url }} #nodejs #release"
env:
# Get your tokens from https://developer.twitter.com/apps
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
```

This workflow is ready to use within the [`releasify`](https://github.com/fastify/releasify) CLI!
Give it a try!

## Development this Action

Read the [developer documentation](https://github.com/actions/javascript-action#package-for-distribution).

## License