diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9db2fbf --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +# ⚠️ IMPORTANT ⚠️ + +# Please do not create a Pull Request for this repository + +The contents of this repository are automatically synced from the parent [Helia Examples Project](https://github.com/ipfs-examples/helia-examples) so any changes made to the standalone repository will be lost after the next sync. + +Please open a PR against [Helia Examples](https://github.com/ipfs-examples/helia-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 [Helia Examples Project](https://github.com/ipfs-examples/helia-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 diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml new file mode 100644 index 0000000..3f8b744 --- /dev/null +++ b/.github/workflows/sync.yml @@ -0,0 +1,19 @@ +name: pull + +on: + workflow_dispatch + +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/helia-examples + source-folder-path: examples/${{ github.event.repository.name }} + source-branch: main + target-branch: main + git-username: github-actions + git-email: github-actions@github.com diff --git a/README.md b/README.md new file mode 100644 index 0000000..19624f3 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +## Getting Started + +This project is a template to be used to pull a given example from a folder/directory of another repository. + +### Requirements + +- Add descriptions to the example (mandatory) +- Check if the github action to perform the pull from another repository exists. +- Turn off issue/wikis/projects/discussions +- Disable Releases/Environments/Packages +- Create a PR against [Helia Examples](https://github.com/ipfs-examples/helia-examples) with your new example in a directory under `./examples` that matches the name of this repo