ethersphere/beeload-action

Toolkit for uploading data to Swarm network with GitHub Actions

Beeload Action (deprecated)

⚠️ Beeload action is deprecated in favor of more flexible set of actions Swarm Actions.

Toolkit for uploading data to Swarm network with GitHub Actions

Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.

This project is intended to be used with Bee version 1.4.1-238867f1. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the official Discord and by keeping an eye on the releases tab.

Table of Contents

• Usage
• Action inputs
• Action outputs
• Contribute
• License

Usage

Sending latest master built to Mattermost

name: Send `master` built link to Mattermost

on:
  push:
    branches:
      - 'master'

jobs:
  check:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Use Node.js 16
        uses: actions/setup-node@v1
        with:
          node-version: '16'

      - name: Install dependencies
        run: npm ci

      # Build process puts the built files into `./build` folder
      - name: Build
        run: npm run build

      # Upload the build folder to Swarm
      - name: Create preview
        id: upload
        uses: ethersphere/beeload-action@master
        with:
          bee-url: https://bee-9.gateway.ethswarm.org # We are using Gateway node that allows small sized files/sites to be uploaded
          postage-batch-id: '0000000000000000000000000000000000000000000000000000000000000000' # Postage Stamps are replaced on Gateway, so we are using dummy string to pass input validations
          token: ${{ secrets.REPO_GHA_PAT }}
          dir: ./build

      # Send notification to Mattermost channel
      - name: Create the Mattermost Message
        run: |
          echo "{\"text\":\"Preview of PR :tada:: ${{ steps.upload.outpus.preview-url }}\"}" > mattermost.json
      - uses: mattermost/action-mattermost-notify@master
        env:
          MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_WEBHOOK_URL }}

PR preview

name: PR preview

on:
  pull_request:
    branches:
      - '**'

jobs:
  check:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Use Node.js 16
        uses: actions/setup-node@v1
        with:
          node-version: '16'

      - name: Install dependencies
        run: npm ci

      # Build process puts the built files into `./build` folder
      - name: Build
        run: npm run build

      # Upload the build folder to Swarm
      - name: Create preview
        uses: ethersphere/beeload-action@master
        with:
          bee-url: https://bee-9.gateway.ethswarm.org # We are using Gateway node that allows small sized files/sites to be uploaded
          postage-batch-id: '0000000000000000000000000000000000000000000000000000000000000000' # Postage Stamps are replaced on Gateway, so we are using dummy string to pass input validations
          preview: true
          token: ${{ secrets.REPO_GHA_PAT }}
          dir: ./build

Action inputs

Name	Description	Default
bee-url	URL of Bee API of your Bee node
bzz-link-url	URL of Bzz.link. It has to contain <<CID>> string, which will be replaced with the CID of the content	https://<<CID>>.bzz.link
postage-batch-id	Batch ID of Postage Stamp that will be used for upload
dir	Folder that contains the built webpage	./build
token	Token to be used for creating of the PR Preview comment.	GITHUB_TOKEN
preview	Flag that enables creating PR Preview comment.	false
extra-params	Extra parameters that you will be passed to swarm-cli calls.

Action outputs

Name	Description
swarm-hash	Swarm hash of the uploaded content
bzz-link	Bzz Link URL

Contribute

There are some ways you can make this module better:

• Consult our open issues and take on one of them
• Help our tests reach 100% coverage!
• Join us in our Discord chat in the #develop-on-swarm channel if you have questions or want to give feedback

Maintainers

• auhau
• vojtechsimetka

See what "Maintainer" means here.

License

BSD-3-Clause

beeload-action's Issues

Add support for feeds

In order to be able to deploy production websites to Swarm, it would be easy useful for this action to support feeds.

This could be done either by conditionally replacing swarm-cli upload with swarm-cli feed upload and adding inputs for:

• topic
• topic-string
• identity

Or adding a separate action that runs swarm-cli feed update.

What would be your preference? I'd be happy to write a PR. 🙂

Verify `swarm-cli` failures with exit code

Use `swarm-cid-js` instead of creating CID from code

See https://github.com/ethersphere/swarm-cid-js

PR previews are not updated with more commits pushed to the PR

It looks like the PR previews are not updated upon new commits landing to the PR.

For example see here: ethersphere/bee-js-docs#97

Be able to provide extra swarm-cli params

I would like to connect to an authenticated bee node and would like to provide -H Authentication: ... parameter to the swarm-cli.