Skip to content

Commit 39c4103

Browse files
committed
First rough draft
1 parent 92a024f commit 39c4103

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
We first launched support for package collections ahead of WWDC 2021 and they are a convenient way to add packages to an Xcode project.
2+
3+
We generate a package collection for all packages by an author or organisation. For example, you can copy a link for the package collection for all of Apple’s packages via [Apple’s author page](https://swiftpackageindex.com/apple) and add it to Xcode's package collections.
4+
5+
Since launching the feature we have been asked if we could support more curated collections that span multiple authors and today we are adding the ability to create package collections for key community efforts.
6+
7+
The way this works is quite similar to adding packages to the Swift Package Index. Instead of adding a package to [packages.json](), you add a whole package list (whose contents _you_ maintain) to [custom-package-collections.json]().
8+
9+
Here’s what this looks like, taking the Swift Server Workgroup Graduated packages as an example:
10+
11+
```
12+
{
13+
"key": "sswg-graduated",
14+
"name": "SSWG Graduated",
15+
"description": "SSWG packages that are in 'graduated' state",
16+
"url": "https://raw.githubusercontent.com/finestructure/sswg-package-lists/refs/heads/main/graduated.json"
17+
}
18+
```
19+
20+
The `key` field essentially determines the URL at which the package collection is available on the Swift Package Index:
21+
22+
[https://swiftpackageindex.com/collections/sswg-graduated](https://swiftpackageindex.com/collections/sswg-graduated)
23+
24+
The `name` is its display name on the collections page as well as on the package page where we should a package’s membership to package collections:
25+
26+
TODO: image package page (needs new badge icon).
27+
28+
The `description` field brielfly explains the motivation for this custom collection. It serves informational purposes and is not displayed.
29+
30+
TODO: describe `badge` attribute.
31+
32+
We will be considering additions to the custom collections list on a case by case basis for package lists that benefit the Swift package ecosystem.
33+
34+
Such lists should be goverened by a group or organisation active in the Swift open source community and have appeal for a significant part of the Swift ecosystem.
35+
36+
The intial set of SSWG collections give an example of these requirements:
37+
38+
- The content of the lists is managed by the Swift Server Workgroup.
39+
- While mainly geared towards server-side development, many packages like for example `swift-crypto` are relevant even for developers not working with server-side Swift.
40+
- Making the maturity levels of these packages visible on the Swift Package Index helps developers find quality packages for their needs.
41+
42+
Please [get in touch](https://discord.gg/vQRb6KkYRw) if you have questions, would like to propose a new custom collection, or open an issue or pull request on the [PackageList repository](https://github.com/SwiftPackageIndex/PackageList/) for discussion.

Resources/Blog/posts.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,8 @@
193193
summary: We are thrilled to announce that Amazon is joining Apple as a supporter of the Swift Package Index by providing infrastructure support.
194194
published_at: 2024-10-28
195195
published: true
196+
- slug: introducing-custom-package-collections
197+
title: Introducing custom package collections
198+
summary: We've added support for custom package collections to allow well-known community efforts to present package collections.
199+
published_at: 2024-11-22
200+
published: false

0 commit comments

Comments
 (0)