@@ -90,7 +90,7 @@ There are three types of package locations:
90
90
91
91
1. Hackage packages
92
92
2. Git and Mecurial repositories
93
- 3. Local or remote archives
93
+ 3. Local or remote archives (such as GitHub archives)
94
94
95
95
All three types support optional tree metadata to be added, which can be used
96
96
for reproducibility and faster downloads. This information can automatically be
@@ -198,30 +198,6 @@ the root of the repository. If you specify a value of `subdirs`, then `'.'` is
198
198
_not_ included by default and needs to be explicitly specified if a required
199
199
package is found in the top-level directory of the repository.
200
200
201
- # ### GitHub
202
-
203
- [:octicons-tag-24 : 1.7.1](https://github.com/commercialhaskell/stack/releases/tag/v1.7.1)
204
-
205
- You can specify a GitHub respository at a specific commit and Stack will obtain
206
- from GitHub an archive file of the files in the repository at that point in its
207
- history. For example :
208
-
209
- ~~~yaml
210
- extra-deps :
211
- - github : snoyberg/http-client
212
- commit : a5f4f30f01366738f913968163d856366d7e0342
213
- ~~~
214
-
215
- !!! note
216
-
217
- An archive file of the files in a GitHub repository at a point in its
218
- history is not the same as a clone of the repository (including its history)
219
- and the updating of any submodules. If you need the latter, use the syntax
220
- for a [Git repository](pantry.md#git-and-mercurial-repositories).
221
-
222
- If the package fails to build due to missing files, it may be that updated
223
- submodules are required.
224
-
225
201
# ### git-annex
226
202
227
203
[git-annex](https://git-annex.branchable.com) is not supported. This is because
@@ -241,7 +217,9 @@ following line:
241
217
fonts export-ignore
242
218
~~~
243
219
244
- ### Local or remote archives
220
+ ### Local or remote archives (such as GitHub archives)
221
+
222
+ #### Filepaths or URLs to archive files
245
223
246
224
You can use filepaths referring to local archive files or HTTP or HTTPS URLs
247
225
referring to remote archive files, either tarballs or ZIP files.
@@ -266,3 +244,27 @@ extra-deps:
266
244
- archive : ../acme-missiles-0.3.tar.gz
267
245
sha256 : e563d8b524017a06b32768c4db8eff1f822f3fb22a90320b7e414402647b735b
268
246
~~~
247
+
248
+ # ### GitHub archive files
249
+
250
+ [:octicons-tag-24 : 1.7.1](https://github.com/commercialhaskell/stack/releases/tag/v1.7.1)
251
+
252
+ You can specify a GitHub respository at a specific commit and Stack will obtain
253
+ from GitHub an archive file of the files in the repository at that point in its
254
+ history. For example :
255
+
256
+ ~~~yaml
257
+ extra-deps :
258
+ - github : snoyberg/http-client
259
+ commit : a5f4f30f01366738f913968163d856366d7e0342
260
+ ~~~
261
+
262
+ !!! note
263
+
264
+ An archive file of the files in a GitHub repository at a point in its
265
+ history is not the same as a clone of the repository (including its history)
266
+ and the updating of any submodules. If you need the latter, use the syntax
267
+ for a [Git repository](pantry.md#git-and-mercurial-repositories).
268
+
269
+ If the package fails to build due to missing files, it may be that updated
270
+ submodules are required.
0 commit comments