Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/myconsciousness/bluesky-post

Use this action to send a post to Bluesky Social from GitHub actions workflow.
https://github.com/myconsciousness/bluesky-post

atproto bluesky bsky dart github-actions post social-media utility

Last synced: 3 days ago
JSON representation

Use this action to send a post to Bluesky Social from GitHub actions workflow.

Awesome Lists containing this project

README

        

[![GitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=ff69b4)](https://github.com/sponsors/myConsciousness)
[![GitHub Sponsor](https://img.shields.io/static/v1?label=Maintainer&message=myConsciousness&logo=GitHub&color=00acee)](https://github.com/myConsciousness)

[![Powered by atproto](https://img.shields.io/badge/Powered%20by-atproto-00acee.svg)](https://github.com/myConsciousness/atproto.dart/tree/main/packages/atproto)
[![Powered by bluesky](https://img.shields.io/badge/Powered%20by-bluesky-00acee.svg)](https://github.com/myConsciousness/atproto.dart/tree/main/packages/bluesky)
[![Powered by bluesky_text](https://img.shields.io/badge/Powered%20by-bluesky_text-00acee.svg)](https://github.com/myConsciousness/atproto.dart/tree/main/packages/bluesky_text)

# Send a Post to Bluesky from GitHub Actions Workflow

Use this action to send a post from GitHub actions workflow.

This action is implemented in the Dart language and uses **[bluesky](https://github.com/myConsciousness/atproto.dart/tree/main/packages/bluesky)** for posting to Bluesky Social.

## Workflow Usage

Configure your workflow to use `myConsciousness/bluesky-post@v5`,
and provide the post you want to send as the `text` input.

Provide Bluesky's ATP server with `identifier` (handle or email) and `password` to create a session.

For example:

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

Now whenever you push something to your repository, GitHub Actions
will post to Bluesky on your behalf.

> **Note**
> In the Bluesky API, the `mention`, `link` and `tag` functions will not work unless
> the `facet` parameter is set correctly when the request is sent,
> but this Action will automatically extract valid handle and link
> from the text and set the facet.

## Specify Authority

Bluesky Social is a distributed microservice.
So you may possibly want to post to a ATP server other than `bsky.social`.

In that case, set the `service` parameter to the authority you wish to post as follows.
If the `service` parameter is omitted, the default is `bsky.social`.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
service: "boobee.blue"
```

## Retry

Server error or network errors may temporarily occur during API communication to the ATP server.
In such cases, retrying at regular intervals may result in successful processing.

This Actions supports `Retry`, and you can specify the maximum number of retries.
The default retry count is 5.

You can specify the following.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
retry-count: 5
```

## Attach Media

You can also post a text with an image of a specified file path attached.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
# You must checkout resources
- uses: actions/checkout@v3

- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
media: cool_photo.png
media-alt: "This is a cool photo!"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

## Attach Language Tags

You can give the post you are sending **BCP47 format language tags**.
One or more language tags can be set and passed to the `langs` parameter in **_CSV format_** as follows.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
langs: "en,ja"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

## Attach Self Labels

You can **label** any post you send.
You can set one or more labels, and pass the value of any label in the `labels` parameter in **_CSV format_** as follows.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
labels: "spam,porn"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

## Attach Tags

You can **tag** any post you send.
You can set one or more tags, and pass the value of any tag in the `tags` parameter in **_CSV format_** as follows.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
tags: "bluesky,awesome"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

> **Note**
> The value specified in the `tags` parameter is different from hashtags in the text,
> which are generally displayed as metadata about the post in Bluesky's clients.

## Markdown Link

You can specify links in a generic markdown format.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "[This is a markdown link!](https://atprotodart.com)"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

## Attach Link Preview

You can attach link preview (link card) with `link-preview-url` parameter.

If a `link-preview-url` parameter is also specified while a `media` parameter is present,
the `media` parameter will be used first.

```yml
name: Send Bluesky Post

on:
[push]

jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: myConsciousness/bluesky-post@v5
with:
text: "Hello, Bluesky!"
link-preview-url: "https://atprotodart.com"
identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
password: ${{ secrets.BLUESKY_PASSWORD }}
```

## More Information

**bluesky_post** was designed and implemented by **_Shinya Kato ([@myConsciousness](https://github.com/myConsciousness))_**.

- [Creator Profile](https://github.com/myConsciousness)
- [License](https://github.com/myConsciousness/atproto.dart/blob/main/LICENSE)
- [Release Note](https://github.com/myConsciousness/atproto.dart/releases)
- [Bug Report](https://github.com/myConsciousness/atproto.dart/issues)