SwiftPackageIndex-Server/Tests/AppTests/__Snapshots__/WebpageSnapshotTests/MaintainerInfoIndex_document.1.html at 82ef583d4d074e6c3770d3ba3b9459458e972792 · SwiftPackageIndex/SwiftPackageIndex-Server · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html>
<html lang="en"><!--Version: test--><!--DB Id: db-id-->
  <head>
    <meta name="robots" content="noindex"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <meta charset="UTF-8"/>
    <meta name="turbo-refresh-method" content="replace"/>
    <meta property="og:site_name" content="The Swift Package Index"/>
    <link rel="canonical" href="http://localhost:8080/"/>
    <meta name="twitter:url" content="http://localhost:8080/"/>
    <meta property="og:url" content="http://localhost:8080/"/>
    <title>Example Package &ndash; Maintainer Information &ndash; Swift Package Index</title>
    <meta name="twitter:title" content="Example Package &ndash; Maintainer Information &ndash; Swift Package Index"/>
    <meta property="og:title" content="Example Package &ndash; Maintainer Information &ndash; Swift Package Index"/>
    <meta name="description" content="Are you a maintainer of Example Package? Get information on how to present your package on the Swift Package Index in the best way."/>
    <meta name="twitter:description" content="Are you a maintainer of Example Package? Get information on how to present your package on the Swift Package Index in the best way."/>
    <meta property="og:description" content="Are you a maintainer of Example Package? Get information on how to present your package on the Swift Package Index in the best way."/>
    <meta name="twitter:card" content="summary"/>
    <meta name="twitter:image" content="http://localhost:8080/images/logo.png"/>
    <meta property="og:image" content="http://localhost:8080/images/logo.png"/>
    <link rel="shortcut icon" href="/images/logo-tiny.png" type="image/png"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index Blog" href="http://localhost:8080/blog/feed.xml"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index – Recently Added Packages" href="http://localhost:8080/packages.rss"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index – Recent Package Releases" href="http://localhost:8080/releases.rss"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index – Recent Major Package Releases" href="http://localhost:8080/releases.rss?major=true"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index – Recent Major & Minor Package Releases" href="http://localhost:8080/releases.rss?major=true&minor=true"/>
    <link rel="alternate" type="application/rss+xml" title="Swift Package Index – Recent Package Pre-Releases" href="http://localhost:8080/releases.rss?pre=true"/>
    <link rel="stylesheet" href="/shared.css?test" data-turbo-track="reload"/>
    <link rel="stylesheet" href="/main.css?test" data-turbo-track="reload"/>
    <script src="/shared.js?test" data-turbo-track="reload" defer></script>
    <script src="/main.js?test" data-turbo-track="reload" defer></script><script async defer data-domain="swiftpackageindex.com" src="https://plausible.io/js/plausible.outbound-links.js"></script>
<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
  </head>
  <body>
    <header>
      <div class="inner">
        <a href="/">
          <h1>
            <img alt="The Swift Package Index logo." width="64" height="64" src="/images/logo.svg"/>Swift Package Index
          </h1>
        </a>
        <nav>
          <ul>
            <li>
              <a class="supporters" href="/supporters">Supporters</a>
            </li>
            <li>
              <a href="/add-a-package">Add a Package</a>
            </li>
            <li>
              <a href="/blog">Blog</a>
            </li>
            <li>
              <a href="/faq">FAQ</a>
            </li>
            <li class="search">
              <form action="/search">
                <input id="query" name="query" type="search" placeholder="Search" spellcheck="false" autocomplete="off" data-gramm="false" data-focus="false"/>
                <button type="submit">
                  <div title="Search"></div>
                </button>
              </form>
            </li>
          </ul>
        </nav>
      </div>
    </header>
    <p class="announcement">Swift Package Index will be temporarily unavailable on Tuesday, 23rd of June for scheduled maintenance.</p>
    <nav class="breadcrumbs">
      <div class="inner">
        <ul>
          <li>
            <a href="/">
              <span>Home</span>
            </a>
          </li>
          <li>
            <a href="/example">
              <span>Example Owner</span>
            </a>
          </li>
          <li>
            <a href="/example/package">
              <span>Example Package</span>
            </a>
          </li>
          <li>
            <span>Information for Maintainers</span>
          </li>
        </ul>
      </div>
    </nav>
    <main>
      <div class="inner">
        <div>
          <h2>Information for Example Package Maintainers</h2>
          <p>Are you the author, or a maintainer of
            <a href="http://localhost:8080/example/package">Example Package</a>? Here's what you need to know to make your package's page on the Swift Package Index, and your README both show the best information about your package.
          </p>
          <h3>Compatibility Badges</h3>
          <p>You can add
            <a href="https://shields.io">shields.io</a> badges to your package's README file. Display your package's compatibility with recent versions of Swift, or with different platforms, or both!
          </p>
          <strong>Swift Version Compatibility Badge</strong>
          <div class="markdown-badges">
            <form class="copyable-input">
              <input type="text" data-button-name="Copy Markdown" data-event-name="Copy Markdown Button" value="[![](https://img.shields.io/endpoint?url=http%3A%2F%2Flocalhost%3A8080%2Fapi%2Fpackages%2Fexample%2Fpackage%2Fbadge%3Ftype%3Dswift-versions)](http://localhost:8080/example/package)" readonly/>
            </form>
            <img alt="Swift Version Compatibility for Example Package" src="https://img.shields.io/endpoint?url=http%3A%2F%2Flocalhost%3A8080%2Fapi%2Fpackages%2Fexample%2Fpackage%2Fbadge%3Ftype%3Dswift-versions"/>
          </div>
          <strong>Platform Compatibility Badge</strong>
          <div class="markdown-badges">
            <form class="copyable-input">
              <input type="text" data-button-name="Copy Markdown" data-event-name="Copy Markdown Button" value="[![](https://img.shields.io/endpoint?url=http%3A%2F%2Flocalhost%3A8080%2Fapi%2Fpackages%2Fexample%2Fpackage%2Fbadge%3Ftype%3Dplatforms)](http://localhost:8080/example/package)" readonly/>
            </form>
            <img alt="Platform Compatibility for Example Package" src="https://img.shields.io/endpoint?url=http%3A%2F%2Flocalhost%3A8080%2Fapi%2Fpackages%2Fexample%2Fpackage%2Fbadge%3Ftype%3Dplatforms"/>
          </div>
          <p>Copy the Markdown above into your package's README file to show always-up-to-date compatibility status for your package.</p>
          <h3>Manifest File</h3>
          <p>You can control more aspects of how the Swift Package Index treats your package repository, including improving build compatibility results and opting into automated DocC documentation hosting.</p>
          <p>As the Swift Package Index scans your package repository, it will look for a manifest file named
            <code>.spi.yml</code>. If found, here are some of the things you can control or enable with it:
          </p>
          <ul>
            <li>
              <p>
                <a href="/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#spiHosting">Hosting your documentation</a> on the Swift Package Index site.
              </p>
            </li>
            <li>
              <p>
                <a href="/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#selfHosting">Configure a link to external self-hosted documentation</a>.
              </p>
            </li>
            <li>
              <p>
                <a href="/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#targetsAndSchemes">Control build targets and schemes</a> to improve your
                <a href="/example/package/builds">package's build results</a>. For more details about the build system, see the
                <a href="/docs/builds">build system documentation</a>.
              </p>
            </li>
            <li>
              <p>If your builds require additional operating system-level dependencies to succeed, you can
                <a href="/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#linuxImages">configure base images for Linux builds</a>.
              </p>
            </li>
          </ul>
          <p>See the
            <a href="/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest">SPIManifest package documentation</a> for more details, or use our
            <a href="/validate-spi-manifest">online manifest validation helper</a> to validate your
            <code>.spi.yml</code> file.
          </p>
          <div id="package-score">
            <h3>Package Score</h3>
            <p>This package has a total score of 117 points. The Swift Package Index uses package score in combination with the relevancy of a search query to influence the ordering of search results.</p>
            <p>The score is currently evaluated based on 10 traits, and the breakdown of each trait is shown below.</p>
            <div class="package-score">Total – 117 points</div>
            <div class="package-score-breakdown">
              <div class="score-trait">
                <p>Archived</p>
                <p>20 points</p>
                <p>Repository is not archived.</p>
              </div>
              <div class="score-trait">
                <p>Contributors</p>
                <p>10 points</p>
                <p>Has 20 contributors.</p>
              </div>
              <div class="score-trait">
                <p>Dependencies</p>
                <p>2 points</p>
                <p>Depends on 3 packages.</p>
              </div>
              <div class="score-trait">
                <p>Documentation</p>
                <p>15 points</p>
                <p>Includes  documentation.</p>
              </div>
              <div class="score-trait">
                <p>Last Activity</p>
                <p>15 points</p>
                <p>Last maintenance activity 10 days ago.</p>
              </div>
              <div class="score-trait">
                <p>License</p>
                <p>10 points</p>
                <p>Has a known license.</p>
              </div>
              <div class="score-trait">
                <p>README</p>
                <p>15 points</p>
                <p>Has a README file.</p>
              </div>
              <div class="score-trait">
                <p>Releases</p>
                <p>10 points</p>
                <p>Has 10 releases.</p>
              </div>
              <div class="score-trait">
                <p>Stars</p>
                <p>20 points</p>
                <p>Has 300 stars.</p>
              </div>
              <div class="score-trait">
                <p>Tests</p>
                <p>0 points</p>
                <p>Has no test targets.</p>
              </div>
            </div>
            <p>The package score is a work in progress. We have an
              <a href="https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/discussions/2591">always-open discussion thread</a> if you are interested in providing feedback on existing traits or would like to propose new ones.
            </p>
          </div>
        </div>
      </div>
    </main>
    <footer>
      <div class="inner">
        <nav>
          <ul>
            <li>
              <a href="/blog">Blog</a>
            </li>
            <li>
              <a href="https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server">GitHub</a>
            </li>
            <li>
              <a href="/privacy">Privacy</a>
            </li>
            <li>
              <a href="https://swiftpackageindex.statuspage.io">System Status</a>
            </li>
            <li>
              <a href="/build-monitor">Build System Monitor</a>
            </li>
            <li>
              <a href="https://mas.to/@SwiftPackageIndex">Mastodon</a>
            </li>
            <li>
              <a href="https://swiftpackageindexing.transistor.fm">Podcast</a>
            </li>
            <li>
              <a href="/ready-for-swift-6">Ready for Swift 6</a>
            </li>
          </ul>
          <small>The Swift Package Index is entirely funded by community sponsorship. Thank you to
            <a href="https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server#funding-and-sponsorship">all our sponsors for their generosity</a>.
          </small>
          <small>The Swift Package Index is operated by SPI Operations Limited, a company registered in the UK with company number 13466692.</small>
          <a rel="me" href="https://mas.to/@SwiftPackageIndex"></a>
          <a rel="me" href="https://mas.to/@SwiftPackageUpdates"></a>
        </nav>
      </div>
    </footer>
    <spi-debug-panel class="hidden">
      <table>
        <tbody></tbody>
      </table>
    </spi-debug-panel>
  </body>
</html>