You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+19-9Lines changed: 19 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,8 @@
33
33
-[Contributing](#contributing)
34
34
-[Guidelines](#guidelines)
35
35
-[Steps to follow after adding a new example](#steps-to-follow-after-adding-a-new-example)
36
+
-[Create a repo](#create-a-repo)
37
+
-[Update `js-ipfs` to run tests against the repo](#update-js-ipfs-to-run-tests-against-the-repo)
36
38
-[Want to hack on IPFS?](#want-to-hack-on-ipfs)
37
39
38
40
## About The Project
@@ -137,15 +139,7 @@ Contributions are what make the open source community such an amazing place to b
137
139
138
140
### Steps to follow after adding a new example
139
141
140
-
- Update `js-ipfs` CI to run the test script of the example
141
-
- Edit the `.travis.yml`, search for the test examples section and add the following:
142
-
143
-
```yml
144
-
- stage: test
145
-
name: examples - {TODO_EXAMPLE NAME}
146
-
script:
147
-
- npm run test:external -- -- -- https://github.com/ipfs-examples/{TODO_GIT_URL}.git
148
-
```
142
+
#### Create a repo
149
143
150
144
- Create a new repository based on (https://github.com/ipfs-examples/example-fork-go-template) following the name: `js-ipfs-{EXAMPLE_NAME}` with a description
151
145
@@ -163,6 +157,22 @@ Contributions are what make the open source community such an amazing place to b
163
157
164
158
- Follow the instruction inside the README
165
159
160
+
#### Update `js-ipfs` to run tests against the repo
161
+
162
+
Open a PR to the [ipfs/js-ipfs](https://github.com/ipfs/js-ipfs) project that edits the `.github/workflows/test.yml` in order to make sure a js-ipfs release does not break your new example.
163
+
164
+
Search `.github/workflows/test.yml` for the `test-examples` section and add a block at the end of the `example` matrix key similar to:
The value of the `deps` key will vary depending on which modules from js-ipfs your example uses. Above we override the `ipfs-core` and `ipfs-http-client` modules, but your example may different deps.
173
+
174
+
Please see the existing setup in `.github/workflows/test.yml` for how to ensure you are overriding the correct modules.
0 commit comments