https://github.com/dhaiwat10/repo-backup-arweave

(WIP) A GitHub action that backs up your repo's source code to Arweave.
https://github.com/dhaiwat10/repo-backup-arweave

Last synced: 2 months ago
JSON representation

(WIP) A GitHub action that backs up your repo's source code to Arweave.

• Host: GitHub
• URL: https://github.com/dhaiwat10/repo-backup-arweave
• Owner: Dhaiwat10
• License: mit
• Created: 2022-09-04T13:21:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-18T19:10:34.000Z (about 2 years ago)
• Last Synced: 2024-09-25T09:22:30.181Z (3 months ago)
• Language: TypeScript
• Size: 1.1 MB
• Stars: 10
• Watchers: 2
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# repo-backup-arweave

A GitHub action that backs up your repo's source code to Arweave.

## How to use

Create a workflow file in your repository at `.github/workflows/repo-backup.yml` with the following contents:

```yaml

name: 'repo-backup'

on:

  push:

    branches:

      - main

jobs:

  repo-backup:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: repo-backup-arweave

        uses: Dhaiwat10/[email protected]

        with:

          arweaveWalletKey: ${{ secrets.ARWEAVE_WALLET_KEY }}

```

Make sure you add your Arweave wallet key as a repository secret in your repository's settings. The name of the secret should be `ARWEAVE_WALLET_KEY`. You can generate a wallet key from [here](https://tokens.arweave.org/). Make sure you have some AR in your wallet. You can get some AR from [here](https://faucet.arweave.net/). You need AR to pay for the transaction fees.

## Running locally

1. Install dependencies

```bash

npm install

```

2. Install [`act`](https://github.com/nektos/act) to run GitHub actions locally

```bash

brew install act

```

3. Make sure you have a Docker daemon running locally

4. Create a `my.secrets` file at the root of the project:

```bash

cp my.secrets.example my.secrets

```

Make sure the file looks like this:

```

ARWEAVE_WALLET_KEY=

```

You need to supply an Arweave wallet's private key because you need to pay for the transaction to upload the data to Arweave.

5. Run the action locally

```bash

npm run dev && npm run action

```