fix: add CI actions to examples (#45)

* feat: add CI actions to examples
* chore: update PR template instructions

README.md

@@ -116,6 +116,9 @@ Contributions are what make the open source community such an amazing place to b
 - Follow the [example-template](`https://github.com/ipfs-examples/example-template`)
   - This repository serves as template to create new examples to guarantee consistency between examples. It contains all the necessary files to create a new example
 
+- Follow the [example-template-fork-&-go](`https://github.com/ipfs-examples/example-fork-go-template`)
+  - This repository serves as template to be used as a reference of how to implement the CI in order to sync the example with a standalone repo (correspondent to each example)
+
 - Examples must:
   - Live inside the `/examples/` folder
   - Have tests and should make use of `test-util-ipfs-example` library

examples/browser-add-readable-stream/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-add-readable-stream/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-add-readable-stream"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-angular/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-angular/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-angular"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-browserify/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-browserify/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-browserify"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-create-react-app/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-create-react-app/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-create-react-app"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-exchange-files/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-exchange-files/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-exchange-files"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-ipns-publish/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-ipns-publish/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-ipns-publish"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-lit/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-lit/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-lit"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-mfs/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-mfs/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-mfs"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-nextjs/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-nextjs/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-nextjs"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-parceljs/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request

examples/browser-parceljs/.github/workflows/sync.yml

@@ -0,0 +1,20 @@
+name: Sync
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: "ipfs-examples/js-ipfs-examples"
+          source-folder-path: "examples/browser-parceljs"
+          source-branch: "master"
+          target-branch: "main"
+          git-username: github-actions
+          git-email: [email protected]

examples/browser-readablestream/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+**IMPORTANT: Please do not create a Pull Request for this repository.**
+
+The contents of this repository are automatically synced from the parent [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request