Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 210ec86

Browse files
oliveriosousaoliveriosousa
authored
fix: add CI actions to examples (#45)
* feat: add CI actions to examples * chore: update PR template instructions
1 parent 044ba8e commit 210ec86

File tree

65 files changed

+1123
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1123
-0
lines changed

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,9 @@ Contributions are what make the open source community such an amazing place to b
116116
- Follow the [example-template](`https://github.com/ipfs-examples/example-template`)
117117
- 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
118118

119+
- Follow the [example-template-fork-&-go](`https://github.com/ipfs-examples/example-fork-go-template`)
120+
- 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)
121+
119122
- Examples must:
120123
- Live inside the `/examples/` folder
121124
- Have tests and should make use of `test-util-ipfs-example` library

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-add-readable-stream"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-angular"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-browserify"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-create-react-app"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-exchange-files"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-ipns-publish"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-lit"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-mfs"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-nextjs"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sync
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
sync:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Pull from another repository
13+
uses: ipfs-examples/actions-pull-directory-from-repo@main
14+
with:
15+
source-repo: "ipfs-examples/js-ipfs-examples"
16+
source-folder-path: "examples/browser-parceljs"
17+
source-branch: "master"
18+
target-branch: "main"
19+
git-username: github-actions
20+
git-email: [email protected]

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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**IMPORTANT: Please do not create a Pull Request for this repository.**
2+
3+
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.
4+
5+
Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/js-ipfs-examples) instead.
6+
7+
## Contributing
8+
9+
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**.
10+
11+
1. Fork the [IPFS Examples Project](https://github.com/ipfs-examples/js-ipfs-examples)
12+
2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
13+
3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
14+
4. Push to the Branch (`git push origin feature/amazing-example`)
15+
5. Open a Pull Request

0 commit comments

Comments
 (0)