Protocol Land Sync GitHub

The Protocol Land Sync GitHub package simplifies the process of syncing Git repositories from Protocol Land to GitHub.

Usage

To sync a repository from Protocol Land to GitHub, you should set up a GitHub Action in your repository on GitHub.

Set Up GitHub Action & Protocol Land Github Sync Configuration

[!IMPORTANT]

You need an Arweave wallet only if the Repository you want to sync from Protocol Land to GitHub is a private repository.

On GitHub

1. Open the repository you want to sync to Protocol Land on GitHub.com. Then, go into:

   Settings Tab -> Secrets and variables -> Actions -> New Repository Secret

2. (Optional) Add a new secret with WALLET for "Name" and your Arweave wallet's JWK in the Secret field, and click the "Add secret" button.

3. (Optional) Add a new secret with FORCE_PUSH for "Name" and true or false in the Secret field, and click the "Add secret" button. You could also write it in the workflow file itself instead of using a secret for it.

4. Add a new secret with PL_REPO_ID for "Name" and your Protocol Land Repo ID in the Secret field, and click the "Add secret" button. You could also write it in the workflow file itself instead of using a secret for it.

5. Setup GitHub Workflow:

   • Using GitHub UI: Switch to the Actions tab and click New workflow button. Nowm on the Choose a workflow page, click set up a workflow yourself. Then, paste this workflow content below into the editor and commit the changes.

   • Using Code Editors: Create a file called protocol-land-github-sync.yml in a subfolder called .github/workflows under your repo's root (create the folder if it doesn't exist). Paste this workflow content below and commit and push to your GitHub repository.

name: Protocol Land to GitHub Sync

on:
  workflow_dispatch:

permissions:
  contents: write

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3
      - name: Sync repo to GitHub
        run: npx protocol-land-sync-github
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          WALLET: ${{ secrets.WALLET }}
          PL_REPO_ID: ${{ secrets.PL_REPO_ID }}
          FORCE_PUSH: ${{ secrets.FORCE_PUSH }}
          GH_REPO_NAME: ${{ github.repository }}

[!NOTE]

This GitHub Action will only run on manual trigger from GitHub UI or using API.

On Protocol Land

6. Make sure the repository is pushed to both GitHub and Protocol Land to start syncing from Protocol Land to GitHub.

7. As seen in the image below, Goto repository settings on Protocol Land. Then configure the following:

• Enable: Click the switch to enable GitHub sync. You can disable it whenever GitHub Sync is not required.
• Repository: Write your Github repository name with username. For example, labscommunity/protocol-land
• Branch: Select the branch that contains the GitHub workflow file.
• Workflow name: Write your workflow file name. For example, protocol-land-github-sync.yml.
• Personal Access Token (PAT): PAT is needed to trigger the GitHub workflow using an API endpoint. It is saved by encrypting with the wallet so it cannot be used by others.
  • To create PAT, goto Fine-grained tokens to create a PAT. Set a token name, expiration, repository access (All repositories or Only select repositories) and permissions (Repository permissions > Actions > Read and write).

8. Now if you have done all the above correctlya and when you make a new commit to Protocol Land repository from UI or CLI, the GitHub workflow is triggered to sync the repository on GitHub.