Skip to content

Commit 77c2610

Browse files
authored
rename project to SwiftServiceBootstrap (#36)
motivation: better name changes: * update license headers * update sanity checks
1 parent a22bf0b commit 77c2610

17 files changed

+72
-70
lines changed

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Code of Conduct
2-
To be a truly great community, SwiftServiceLauncher needs to welcome developers from all walks of life,
2+
To be a truly great community, SwiftServiceBootstrap needs to welcome developers from all walks of life,
33
with different backgrounds, and with a wide range of experience. A diverse and friendly
44
community will have more great ideas, more unique perspectives, and produce more great
5-
code. We will work diligently to make the SwiftServiceLauncher community welcoming to everyone.
5+
code. We will work diligently to make the SwiftServiceBootstrap community welcoming to everyone.
66

7-
To give clarity of what is expected of our members, SwiftServiceLauncher has adopted the code of conduct
7+
To give clarity of what is expected of our members, SwiftServiceBootstrap has adopted the code of conduct
88
defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
99
communities, and we think it articulates our values well. The full text is copied below:
1010

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ that your contributions are licensed under the Apache 2.0 license (see
1010

1111
Please ensure to specify the following:
1212

13-
* SwiftServiceLauncher commit hash
14-
* Contextual information (e.g. what you were trying to achieve with SwiftServiceLauncher)
13+
* SwiftServiceBootstrap commit hash
14+
* Contextual information (e.g. what you were trying to achieve with SwiftServiceBootstrap)
1515
* Simplest possible steps to reproduce
1616
* More complex the steps are, lower the priority will be.
1717
* A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
@@ -24,10 +24,10 @@ Please ensure to specify the following:
2424
### Example
2525

2626
```
27-
SwiftServiceLauncher commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
27+
SwiftServiceBootstrap commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
2828
2929
Context:
30-
While load testing my HTTP web server written with SwiftServiceLauncher, I noticed
30+
While load testing my HTTP web server written with SwiftServiceBootstrap, I noticed
3131
that one file descriptor is leaked per request.
3232
3333
Steps to reproduce:
@@ -50,7 +50,7 @@ My system has IPv6 disabled.
5050

5151
## Writing a Patch
5252

53-
A good SwiftServiceLauncher patch is:
53+
A good SwiftServiceBootstrap patch is:
5454

5555
1. Concise, and contains as few changes as needed to achieve the end result.
5656
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
@@ -65,7 +65,7 @@ We require that your commit messages match our template. The easiest way to do t
6565

6666
### Make sure Tests work on Linux
6767

68-
SwiftServiceLauncher uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
68+
SwiftServiceBootstrap uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
6969
For this reason, whenever you add new tests **you have to run a script** that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby ./scripts/generate_linux_tests.rb` at the root of the package and check the changes it made.
7070

7171
## How to contribute your work

CONTRIBUTORS.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
For the purpose of tracking copyright, this is the list of individuals and
2-
organizations who have contributed source code to SwiftServiceLauncher.
2+
organizations who have contributed source code to SwiftServiceBootstrap.
33

44
For employees of an organization/company where the copyright of work done
55
by employees of that company is held by the company itself, only the company
@@ -11,6 +11,8 @@ needs to be listed here.
1111

1212
### Contributors
1313

14+
- Johannes Weiss <[email protected]>
15+
- Konrad `ktoso` Malawski <[email protected]>
1416
- Tomer Doron <[email protected]>
1517
- Yim Lee <[email protected]>
1618

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# SwiftServiceLauncher
1+
# SwiftServiceBootstrap
22

3-
SwiftServiceLauncher provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
3+
SwiftServiceBootstrap provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
44
It also provides a `Signal`-based shutdown hook, to shutdown on signals like `TERM` or `INT`.
55

6-
SwiftServiceLauncher was designed with the idea that every application has some startup and shutdown workflow-like-logic which is often sensitive to failure and hard to get right.
6+
SwiftServiceBootstrap was designed with the idea that every application has some startup and shutdown workflow-like-logic which is often sensitive to failure and hard to get right.
77
The library codes this common need in a safe and reusable way that is non-framework specific, and designed to be integrated with any server framework or directly in an application.
88

9-
This is the beginning of a community-driven open-source project actively seeking contributions, be it code, documentation, or ideas. What SwiftServiceLauncher provides today is covered in the [API docs](https://swift-server.github.io/swift-service-launcher/), but it will continue to evolve with community input.
9+
This is the beginning of a community-driven open-source project actively seeking contributions, be it code, documentation, or ideas. What SwiftServiceBootstrap provides today is covered in the [API docs](https://swift-server.github.io/swift-service-launcher/), but it will continue to evolve with community input.
1010

1111
## Getting started
1212

13-
If you have a server-side Swift application or a cross-platform (e.g. Linux, macOS) application, and you would like to manage its startup and shutdown lifecycle, SwiftServiceLauncher is a great idea. Below you will find all you need to know to get started.
13+
If you have a server-side Swift application or a cross-platform (e.g. Linux, macOS) application, and you would like to manage its startup and shutdown lifecycle, SwiftServiceBootstrap is a great idea. Below you will find all you need to know to get started.
1414

1515
### Adding the dependency
1616

@@ -20,10 +20,10 @@ To add a dependency on the package, declare it in your `Package.swift`:
2020
.package(url: "https://github.com/swift-server/swift-service-launcher.git", from: "1.0.0"),
2121
```
2222

23-
and to your application target, add "SwiftServiceLauncher" to your dependencies:
23+
and to your application target, add "SwiftServiceBootstrap" to your dependencies:
2424

2525
```swift
26-
.target(name: "BestExampleApp", dependencies: ["SwiftServiceLauncher"]),
26+
.target(name: "BestExampleApp", dependencies: ["SwiftServiceBootstrap"]),
2727
```
2828

2929
### Defining the lifecycle
@@ -195,7 +195,7 @@ In more complex cases, when signal trapping based shutdown is not appropriate, y
195195

196196
[SwiftNIO](https://github.com/apple/swift-nio) is a popular networking library that among other things provides Future abstraction named `EventLoopFuture`.
197197

198-
SwiftServiceLauncher comes with a compatibility module designed to make managing SwiftNIO based resources easy.
198+
SwiftServiceBootstrap comes with a compatibility module designed to make managing SwiftNIO based resources easy.
199199

200200
Once you import `ServiceLauncherNIOCompat` module, `Lifecycle.Handler` gains a static helpers named `eventLoopFuture` designed to help simplify the registration call to:
201201

Sources/Lifecycle/Lifecycle.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/Lifecycle/Locks.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/LifecycleNIOCompat/Bridge.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/LifecycleTests/ComponentLifecycleTests+XCTest.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/LifecycleTests/ComponentLifecycleTests.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/LifecycleTests/Helpers.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftServiceLauncher open source project
3+
// This source file is part of the SwiftServiceBootstrap open source project
44
//
5-
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceLauncher project authors
5+
// Copyright (c) 2019-2020 Apple Inc. and the SwiftServiceBootstrap project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftServiceLauncher project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftServiceBootstrap project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

0 commit comments

Comments
 (0)