|
1 |
| -# Releasing swiftly |
| 1 | +# Releasing |
| 2 | + |
| 3 | +Swiftly and the swiftly-install release script have different release schedules and their version numbers do not correspond. Below is instructions for releasing each. |
| 4 | + |
| 5 | +## Releasing swiftly |
2 | 6 |
|
3 | 7 | 1. Check out the commit you wish to create a release for. Ensure no other local modifications or changes are present.
|
4 | 8 |
|
5 |
| -1. Ensure the version string in `Swiftly.swift` is accurate. If it is not, push another commit updating it to the proper value. |
| 9 | +2. Ensure the version string in `SwiftlyCore/SwiftlyCore.swift` is accurate. If it is not, push another commit updating it to the proper value. |
| 10 | + |
| 11 | +3. Create a tag on that commit with the format "x.y.z". Do not omit "z", even if its value is 0. |
| 12 | + |
| 13 | +4. Build the executables for the release by running ./scripts/build_release.sh from the root of the swiftly repository (do this once on an x86_64 machine and once on an aarch64 one) |
| 14 | + |
| 15 | +5. Push the tag to `origin`. `git push origin <tag_name>` |
| 16 | + |
| 17 | +6. Go to the GitHub page for the new tag, click edit tag, add an appropriate description, attach the prebuilt executables, and click "Publish Release". |
| 18 | + |
| 19 | +## Releasing swiftly-install |
| 20 | + |
| 21 | +1. Check out the commit you wish to create a release for. Ensure no other local modifications or changes are present. |
6 | 22 |
|
7 |
| -1. Create a tag on that commit with the format "x.y.z". Do not omit "z", even if its value is 0. |
| 23 | +2. Ensure the version string `SWIFTLY_INSTALL_VERSION` in `install/swiftly-install.sh` is accurate. If it is not, push another commit updating it to the proper value. |
8 | 24 |
|
9 |
| -1. Build the executables for the release by running ./scripts/build_release.sh from the root of the swiftly repository (do this once on an x86_64 machine and once on an aarch64 one) |
| 25 | +3. Create a tag on that commit with the format "swiftly-install-x.y.z". Do not omit "z", even if its value is 0. |
10 | 26 |
|
11 |
| -1. Push the tag to `origin`. |
| 27 | +4. Push the tag to `origin`. `git push origin <tag_name>` |
12 | 28 |
|
13 |
| -1. Go to the GitHub page for the new tag, click edit tag, add an appropriate description, attach the prebuilt executables, and click "Publish Release". |
| 29 | +5. Copy `install/swiftly-install.sh` to website branch of repository |
0 commit comments