{"id":13711200,"url":"https://github.com/ethersphere/beeload-action","last_synced_at":"2025-05-06T20:32:14.406Z","repository":{"id":42469655,"uuid":"422529594","full_name":"ethersphere/beeload-action","owner":"ethersphere","description":"Toolkit for uploading data to Swarm network with GitHub Actions","archived":true,"fork":false,"pushed_at":"2022-04-04T12:52:32.000Z","size":197,"stargazers_count":0,"open_issues_count":3,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-08-03T23:23:20.749Z","etag":null,"topics":["bee","github-actions","swarm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2021-10-29T10:15:08.000Z","updated_at":"2023-01-28T01:53:40.000Z","dependencies_parsed_at":"2022-09-12T02:20:43.864Z","dependency_job_id":null,"html_url":"https://github.com/ethersphere/beeload-action","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbeeload-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbeeload-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbeeload-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbeeload-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/beeload-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224528356,"owners_count":17326349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bee","github-actions","swarm"],"created_at":"2024-08-02T23:01:05.662Z","updated_at":"2024-11-13T21:31:36.531Z","avatar_url":"https://github.com/ethersphere.png","language":"JavaScript","funding_links":[],"categories":["Projects"],"sub_categories":["CI/CD"],"readme":"# Beeload Action (deprecated) \n\n### ⚠️ Beeload action is deprecated in favor of more flexible set of actions [Swarm Actions](https://github.com/ethersphere/swarm-actions).\n\n[![](https://img.shields.io/badge/made%20by-Swarm-blue.svg?style=flat-square)](https://swarm.ethereum.org/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n\n\u003e Toolkit for uploading data to Swarm network with GitHub Actions\n\n**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.**\n\nThis project is intended to be used with **Bee version \u003c!-- SUPPORTED_BEE_START --\u003e1.4.1-238867f1\u003c!-- SUPPORTED_BEE_END --\u003e**. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/bee-js/releases).\n\n## Table of Contents\n\n- [Usage](#usage)\n- [Action inputs](#action-inputs)\n- [Action outputs](#action-outputs)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Usage\n\n### Sending latest `master` built to Mattermost\n\n```yaml\nname: Send `master` built link to Mattermost\n\non:\n  push:\n    branches:\n      - 'master'\n\njobs:\n  check:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v2\n\n      - name: Use Node.js 16\n        uses: actions/setup-node@v1\n        with:\n          node-version: '16'\n\n      - name: Install dependencies\n        run: npm ci\n\n      # Build process puts the built files into `./build` folder\n      - name: Build\n        run: npm run build\n\n      # Upload the build folder to Swarm\n      - name: Create preview\n        id: upload\n        uses: ethersphere/beeload-action@master\n        with:\n          bee-url: https://bee-9.gateway.ethswarm.org # We are using Gateway node that allows small sized files/sites to be uploaded\n          postage-batch-id: '0000000000000000000000000000000000000000000000000000000000000000' # Postage Stamps are replaced on Gateway, so we are using dummy string to pass input validations\n          token: ${{ secrets.REPO_GHA_PAT }}\n          dir: ./build\n\n      # Send notification to Mattermost channel\n      - name: Create the Mattermost Message\n        run: |\n          echo \"{\\\"text\\\":\\\"Preview of PR :tada:: ${{ steps.upload.outpus.preview-url }}\\\"}\" \u003e mattermost.json\n      - uses: mattermost/action-mattermost-notify@master\n        env:\n          MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_WEBHOOK_URL }}\n```\n\n### PR preview\n\n```yaml\nname: PR preview\n\non:\n  pull_request:\n    branches:\n      - '**'\n\njobs:\n  check:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v2\n\n      - name: Use Node.js 16\n        uses: actions/setup-node@v1\n        with:\n          node-version: '16'\n\n      - name: Install dependencies\n        run: npm ci\n\n      # Build process puts the built files into `./build` folder\n      - name: Build\n        run: npm run build\n\n      # Upload the build folder to Swarm\n      - name: Create preview\n        uses: ethersphere/beeload-action@master\n        with:\n          bee-url: https://bee-9.gateway.ethswarm.org # We are using Gateway node that allows small sized files/sites to be uploaded\n          postage-batch-id: '0000000000000000000000000000000000000000000000000000000000000000' # Postage Stamps are replaced on Gateway, so we are using dummy string to pass input validations\n          preview: true\n          token: ${{ secrets.REPO_GHA_PAT }}\n          dir: ./build\n```\n\n## Action inputs\n\n| Name | Description | Default |\n| --- | --- | --- |\n| `bee-url` | URL of Bee API of your Bee node | |\n| `bzz-link-url` | URL of Bzz.link. It has to contain `\u003c\u003cCID\u003e\u003e` string, which will be replaced with the CID of the content | `https://\u003c\u003cCID\u003e\u003e.bzz.link` |\n| `postage-batch-id` | Batch ID of Postage Stamp that will be used for upload | |\n| `dir` | Folder that contains the built webpage | `./build` |\n| `token` | Token to be used for creating of the PR Preview comment. | `GITHUB_TOKEN` |\n| `preview` | Flag that enables creating PR Preview comment. | `false` |\n| `extra-params` | Extra parameters that you will be passed to [swarm-cli](https://github.com/ethersphere/swarm-cli) calls. | |\n\n## Action outputs\n\n| Name | Description |\n| --- | --- |\n| `swarm-hash` | Swarm hash of the uploaded content |\n| `bzz-link` | Bzz Link URL |\n\n## Contribute\n\nThere are some ways you can make this module better:\n\n- Consult our [open issues](https://github.com/ethersphere/beeload-action/issues) and take on one of them\n- Help our tests reach 100% coverage!\n- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or want to give feedback\n\n## Maintainers\n\n- [auhau](https://github.com/auhau)\n- [vojtechsimetka](https://github.com/vojtechsimetka)\n\nSee what \"Maintainer\" means [here](https://github.com/ethersphere/repo-maintainer).\n\n## License\n\n[BSD-3-Clause](./LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbeeload-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fbeeload-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbeeload-action/lists"}