https://github.com/ruchernchong/tweet-post-action

tweet-post-action
https://github.com/ruchernchong/tweet-post-action

Last synced: about 10 hours ago
JSON representation

tweet-post-action

• Host: GitHub
• URL: https://github.com/ruchernchong/tweet-post-action
• Owner: ruchernchong
• Created: 2023-03-24T18:12:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-19T04:19:34.000Z (6 months ago)
• Last Synced: 2025-01-18T02:40:42.952Z (3 days ago)
• Language: TypeScript
• Size: 221 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tweet Post Action

[![.github/workflows/main.yml](https://github.com/ruchernchong/tweet-post-action/actions/workflows/main.yml/badge.svg)](https://github.com/ruchernchong/tweet-post-action/actions/workflows/main.yml)

This action automatically creates a tweet on Twitter when a new post is being committed to a GitHub repository.

## Inputs

### `hostname`

**Required** - The hostname of the item. e.g. `https://example.com/blog`

### `path`

**Required** - The path to the posts folder relative to the root directory. e.g. `posts`

### `end-with`

**(Optional)** - For tweets that exceeded the limits, the tweet will have to be truncated with an ellipses by default. e.g. `This is a very long tweet and I cannot finish the 👇🏼`

**default** - `...`

## Example usage

```yaml

uses: ruchernchong/tweet-post@v1

with:

  hostname: "https://example.com"

  path: "posts"

  end-with: "👇🏼"

env:

  CONSUMER_KEY: ${{ secrets.CONSUMER_KEY }}

  CONSUMER_SECRET: ${{ secrets.CONSUMER_SECRET }}

  ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

  ACCESS_TOKEN_SECRET: ${{ secrets.ACCESS_TOKEN_SECRET }}

```