diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index ba8ed069..38fe54e2 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -12,6 +12,7 @@ needs to be listed here. - Craig Newell - Eduardo Perez - Florian Reinhart +- Franz Busch - Geoff Verdouw - Jeffrey Macko - Jonny @@ -19,12 +20,17 @@ needs to be listed here. - Laurent Gaches - Lukáš Petr - Mads Odgaard +- Mark Woollard - Nikola Paunović - Roderic Campbell - Simon Kempendorf +- Sven A. Schmidt - Tanner - Tanner Nelson +- Tim Condon <0xTim@users.noreply.github.com> - Timothy Ellis <3098078+TimAEllis@users.noreply.github.com> +- Timothy Ellis +- Vojtech Rylko - grosch - itcohorts - tanner0101 diff --git a/README.md b/README.md index 619eb004..4c3f5706 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,7 @@ To install `APNSwift`, just add the package as a dependency in your [**Package.s ```swift dependencies: [ - .package(url: "https://github.com/swift-server-community/APNSwift.git", from: "4.0.0"), -] -``` -If youd like to give our bleeding edge release a try, which is what the Readme is expecting use `5.0.0-beta.N`. If you need the old Readme, see [here](https://github.com/swift-server-community/APNSwift/tree/4.0.0) - -```swift -dependencies: [ - .package(url: "https://github.com/swift-server-community/APNSwift.git", from: "5.0.0-beta.2"), + .package(url: "https://github.com/swift-server-community/APNSwift.git", from: "5.0.0"), ] ``` @@ -189,3 +182,4 @@ Once inside configure your App Bundle ID and assign your development team. Build * Pitch discussion: [Swift Server Forums](https://forums.swift.org/t/apple-push-notification-service-implementation-pitch/20193) * Proposal: [SSWG-0006](https://forums.swift.org/t/feedback-nioapns-nio-based-apple-push-notification-service/24393) +* 5.0 breaking changings: [Swift Server Forums]([Blog post here on breaking changing](https://forums.swift.org/t/apnswift-5-0-0-beta-release/60075/3)) diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..eaae65f2 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,30 @@ +# Updating code/Release workflow + +APNSwift follows a standard open source release process + +## Issue and Pull Request Management + +The primary objective of managing Issues and Pull Requests (PRs) is to enable easy reference to them in the future and to ensure a clear record of when specific issues were addressed in a release. + +- **Creating GitHub Issues and Linking PRs:** Every significant task should have an associated GitHub issue, and when a PR resolves an issue, it should be linked using GitHub's "resolves #1234" mechanism or another clear indication of the associated issue. + +- **Closing Issues and PRs:** When a PR gets merged, the related issue is automatically closed, and the issue is assigned to the milestone corresponding to the release in which the change will be included. + +- **Handling PRs without Associated Issues:** In cases where a pull request is made directly without an associated issue, it should be linked to the relevant milestone for the release. However, it's essential not to assign both an issue and a pull request related to the same task to the same milestone, as this could lead to confusion regarding duplicated issue resolutions. + +## Release Process + +When preparing for a new release, APNSWift will follow these steps. Let's use version `1.2.3` as an example: + +1. Check all outstanding PRs, and if any can be merged for the current release (`1.2.3`), consider doing so. + +2. Ensure that all recently closed PRs or issues are appropriately assigned to the milestone (`1.2.3`), if not already done. + +3. Ensure all documentation is up to date + +4. Create a new milestone for the next release, e.g., `1.2.4` or `1.3.0`, and move any remaining issues to it. This way, these tasks are carried over to the "next" release and can be easily located and prioritized. + +5. Close the current milestone (`1.2.3`). + +6. Finally, go to the GitHub releases page and [draft a new release](https://github.com/apple/swift-metrics/releases/new) with the details of the release version (`1.2.3` in this case) and any relevant release notes or changes. Be sure to include and create the new tag `1.2.3`. + diff --git a/SECURITY.md b/SECURITY.md index 8cdc15f3..fbe201a1 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,10 +2,13 @@ ## Supported Versions +APNSwift will support the current release minus 1 with security updates + | Version | Supported | | ------- | ------------------ | +| 5.x.x | :white_check_mark: | | 4.x.x | :white_check_mark: | -| 3.x.x | :white_check_mark: | +| 3.x.x | ❌ | | 2.x.x | ❌ | | 1.x.x | ❌ | diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..8849fd37 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,12 @@ +APNSwift will support the current release minus 1 with direct support. While the latest versions will get new features the N-1 release will get bug fixes and security fixes only. + +To receive suport, please [open an issue](https://github.com/swift-server-community/APNSwift/issues), [create a discussion([https://github.com/swift-server-community/APNSwift/discussions), or join [this](https://join.slack.com/t/swift-open-source/shared_invite/zt-203tkfk9g-rCNUZgj5kKhz9QW6Z9Gwqw) slack and enter the channel #apns. +Please refer to the [Contributing](CONTRIBUTING.md) section for more information on how to contribute to the project. + +| Version | Supported | +| ------- | ------------------ | +| 5.x.x | :white_check_mark: | +| 4.x.x | :white_check_mark: | +| 3.x.x | ❌ | +| 2.x.x | ❌ | +| 1.x.x | ❌ |