https://github.com/alexanderschau/ipfs-pinning-action

Pin your files to IPFS using GitHub Actions 🚀
https://github.com/alexanderschau/ipfs-pinning-action

ipfs ipfs-pinning-services pinata

Last synced: about 2 months ago
JSON representation

Pin your files to IPFS using GitHub Actions 🚀

• Host: GitHub
• URL: https://github.com/alexanderschau/ipfs-pinning-action
• Owner: alexanderschau
• License: mit
• Created: 2021-03-21T12:54:37.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-25T10:22:48.000Z (over 2 years ago)
• Last Synced: 2025-02-13T16:17:07.773Z (3 months ago)
• Topics: ipfs, ipfs-pinning-services, pinata
• Language: Dockerfile
• Homepage:
• Size: 466 KB
• Stars: 26
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# IPFS Pinning GitHub Action

![hero image](preview-image.png)

This GitHub Action helps you to publish your website/assets to IPFS Pinning Services (e.g. [Pinata](https://pinata.cloud/documentation#PinningServicesAPI) or [Filebase](https://docs.filebase.com/api-documentation/ipfs-pinning-service-api) using the official [IPFS Remote Pinning API](https://ipfs.github.io/pinning-services-api-spec/).

## Usage

You can use this Action directly from your GitHub workflow. You can find the required credentials on your Pinning Services Website.

```yaml

#/.github/workflows/main.yml

on: [push]

jobs:

  pin_to_ipfs:

    runs-on: ubuntu-latest

    name: Publish

    steps:

    - uses: actions/checkout@v2

    - name: IPFS Publish

      id: IPFS

      uses: alexanderschau/[email protected]

      with:

        path_to_add: 'your/path/' #Required

        endpoint: ${{ secrets.ENDPOINT }} #Required

        access_token: ${{ secrets.ACCESS_TOKEN }} #Required

        pin_name: 'github-actions-test' #Optional

```

## Outputs

### `cid`

Your content's IPFS content identifier e.g.

`bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am`

## Contribute

If you have ideas to improve this action or found a bug, feel free to submit a PR or open an issue.

## License

MIT © Alexander Schau