Skip to content

Commit 55c10e9

Browse files
Update RELEASING.md to match the new Tuist setup (#596)
Updated `RELEASING.md` based on our conversation from today. Not updating the release script just yet as we are looking to remove `CHANGELOG.md` completely in favour of conventional commits. I also created a GitHub [release](https://github.com/square/Listable/releases/tag/16.4.0) for the latest version based on our conversation. ### Checklist Please do the following before merging: - [x] Ensure any public-facing changes are reflected in the [changelog](https://github.com/square/Listable/blob/main/CHANGELOG.md). Include them in the `Main` section.
1 parent 1d15048 commit 55c10e9

3 files changed

Lines changed: 12 additions & 121 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,113 +1210,3 @@ listActions.scrolling.scrollToSection(
12101210
## Earlier - Internal Only
12111211

12121212
Earlier releases were ad-hoc and not tracked. To see all changes, please reference [closed PRs on Github](https://github.com/kyleve/Listable/pulls?q=is%3Apr+is%3Aclosed).
1213-
1214-
1215-
[Main]: https://github.com/square/Listable/compare/16.4.0...main
1216-
[16.4.0]: https://github.com/square/Listable/compare/16.3.0...16.4.0
1217-
[16.3.0]: https://github.com/square/Listable/compare/16.2.0...16.3.0
1218-
[16.2.0]: https://github.com/square/Listable/compare/16.1.0...16.2.0
1219-
[16.1.0]: https://github.com/square/Listable/compare/16.0.4...16.1.0
1220-
[16.0.4]: https://github.com/square/Listable/compare/16.0.3...16.0.4
1221-
[16.0.3]: https://github.com/square/Listable/compare/16.0.2...16.0.3
1222-
[16.0.2]: https://github.com/square/Listable/compare/16.0.1...16.0.2
1223-
[16.0.1]: https://github.com/square/Listable/compare/16.0.0...16.0.1
1224-
[16.0.0]: https://github.com/square/Listable/compare/15.0.2...16.0.0
1225-
[15.0.2]: https://github.com/square/Listable/compare/15.0.1...15.0.2
1226-
[15.0.1]: https://github.com/square/Listable/compare/15.0.0...15.0.1
1227-
[15.0.0]: https://github.com/square/Listable/compare/14.5.0...15.0.0
1228-
[14.5.0]: https://github.com/square/Listable/compare/14.4.1...14.5.0
1229-
[14.4.1]: https://github.com/square/Listable/compare/14.4.0...14.4.1
1230-
[14.4.0]: https://github.com/square/Listable/compare/14.3.1...14.4.0
1231-
[14.3.1]: https://github.com/square/Listable/compare/14.3.0...14.3.1
1232-
[14.3.0]: https://github.com/square/Listable/compare/14.2.0...14.3.0
1233-
[14.2.0]: https://github.com/square/Listable/compare/14.1.0...14.2.0
1234-
[14.1.0]: https://github.com/square/Listable/compare/14.0.3...14.1.0
1235-
[14.0.3]: https://github.com/square/Listable/compare/14.0.2...14.0.3
1236-
[14.0.2]: https://github.com/square/Listable/compare/14.0.1...14.0.2
1237-
[14.0.1]: https://github.com/square/Listable/compare/14.0.0...14.0.1
1238-
[14.0.0]: https://github.com/square/Listable/compare/13.1.0...14.0.0
1239-
[13.1.0]: https://github.com/square/Listable/compare/13.0.0...13.1.0
1240-
[13.0.0]: https://github.com/square/Listable/compare/12.0.0...13.0.0
1241-
[12.0.0]: https://github.com/square/Listable/compare/11.0.0...12.0.0
1242-
[11.0.0]: https://github.com/square/Listable/compare/10.3.1...11.0.0
1243-
[10.3.1]: https://github.com/square/Listable/compare/10.3.0...10.3.1
1244-
[10.3.0]: https://github.com/square/Listable/compare/10.2.0...10.3.0
1245-
[10.2.0]: https://github.com/square/Listable/compare/10.1.0...10.2.0
1246-
[10.1.0]: https://github.com/square/Listable/compare/10.0.1...10.1.0
1247-
[10.0.1]: https://github.com/square/Listable/compare/10.0.0...10.0.1
1248-
[10.0.0]: https://github.com/square/Listable/compare/9.0.0...10.0.0
1249-
[9.0.0]: https://github.com/square/Listable/compare/8.2.0...9.0.0
1250-
[8.2.0]: https://github.com/square/Listable/compare/8.1.2...8.2.0
1251-
[8.1.2]: https://github.com/square/Listable/compare/8.1.1...8.1.2
1252-
[8.1.1]: https://github.com/square/Listable/compare/8.1.0...8.1.1
1253-
[8.1.0]: https://github.com/square/Listable/compare/8.0.5...8.1.0
1254-
[8.0.5]: https://github.com/square/Listable/compare/8.0.4...8.0.5
1255-
[8.0.4]: https://github.com/square/Listable/compare/8.0.3...8.0.4
1256-
[8.0.3]: https://github.com/square/Listable/compare/8.0.2...8.0.3
1257-
[8.0.2]: https://github.com/square/Listable/compare/8.0.1...8.0.2
1258-
[8.0.1]: https://github.com/square/Listable/compare/8.0.0...8.0.1
1259-
[8.0.0]: https://github.com/square/Listable/compare/7.2.0...8.0.0
1260-
[7.2.0]: https://github.com/square/Listable/compare/7.1.2...7.2.0
1261-
[7.1.2]: https://github.com/square/Listable/compare/7.1.1...7.1.2
1262-
[7.1.1]: https://github.com/square/Listable/compare/7.1.0...7.1.1
1263-
[7.1.0]: https://github.com/square/Listable/compare/7.0.0...7.1.0
1264-
[7.0.0]: https://github.com/square/Listable/compare/6.0.0...7.0.0
1265-
[6.0.0]: https://github.com/square/Listable/compare/5.2.1...6.0.0
1266-
[5.2.1]: https://github.com/square/Listable/compare/5.2.0...5.2.1
1267-
[5.2.0]: https://github.com/square/Listable/compare/5.1.0...5.2.0
1268-
[5.1.0]: https://github.com/square/Listable/compare/5.0.1...5.1.0
1269-
[5.0.1]: https://github.com/square/Listable/compare/5.0.0...5.0.1
1270-
[5.0.0]: https://github.com/square/Listable/compare/4.4.0...5.0.0
1271-
[4.4.0]: https://github.com/square/Listable/compare/4.3.1...4.4.0
1272-
[4.3.1]: https://github.com/square/Listable/compare/4.3.0...4.3.1
1273-
[4.3.0]: https://github.com/square/Listable/compare/4.2.0...4.3.0
1274-
[4.2.0]: https://github.com/square/Listable/compare/4.1.0...4.2.0
1275-
[4.1.0]: https://github.com/square/Listable/compare/4.0.0...4.1.0
1276-
[4.0.0]: https://github.com/square/Listable/compare/3.2.1...4.0.0
1277-
[3.2.1]: https://github.com/square/Listable/compare/3.2.0...3.2.1
1278-
[3.2.0]: https://github.com/square/Listable/compare/3.1.0...3.2.0
1279-
[3.1.0]: https://github.com/square/Listable/compare/3.0.0...3.1.0
1280-
[3.0.0]: https://github.com/square/Listable/compare/2.0.0...3.0.0
1281-
[2.0.0]: https://github.com/square/Listable/compare/1.0.2...2.0.0
1282-
[1.0.2]: https://github.com/square/Listable/compare/1.0.1...1.0.2
1283-
[1.0.1]: https://github.com/square/Listable/compare/1.0.0...1.0.1
1284-
[1.0.0]: https://github.com/square/Listable/compare/0.30.1...1.0.0
1285-
[0.30.1]: https://github.com/square/Listable/compare/0.30.0...0.30.1
1286-
[0.30.0]: https://github.com/square/Listable/compare/0.29.3...0.30.0
1287-
[0.29.3]: https://github.com/square/Listable/compare/0.29.2...0.29.3
1288-
[0.29.2]: https://github.com/square/Listable/compare/0.29.1...0.29.2
1289-
[0.29.1]: https://github.com/square/Listable/compare/0.29.0...0.29.1
1290-
[0.29.0]: https://github.com/square/Listable/compare/0.28.0...0.29.0
1291-
[0.28.0]: https://github.com/square/Listable/compare/0.27.1...0.28.0
1292-
[0.27.1]: https://github.com/square/Listable/compare/0.27.0...0.27.1
1293-
[0.27.0]: https://github.com/square/Listable/compare/0.26.1...0.27.0
1294-
[0.26.1]: https://github.com/square/Listable/compare/0.26.0...0.26.1
1295-
[0.26.0]: https://github.com/square/Listable/compare/0.25.1...0.26.0
1296-
[0.25.0]: https://github.com/square/Listable/compare/0.25.0...0.25.1
1297-
[0.25.0]: https://github.com/square/Listable/compare/0.24.0...0.25.0
1298-
[0.24.0]: https://github.com/square/Listable/compare/0.23.2...0.24.0
1299-
[0.23.2]: https://github.com/square/Listable/compare/0.23.1...0.23.2
1300-
[0.23.1]: https://github.com/square/Listable/compare/0.23.0...0.23.1
1301-
[0.23.0]: https://github.com/square/Listable/compare/0.22.2...0.23.0
1302-
[0.22.2]: https://github.com/square/Listable/compare/0.22.1...0.22.2
1303-
[0.22.1]: https://github.com/square/Listable/compare/0.22.0...0.22.1
1304-
[0.22.0]: https://github.com/square/Listable/compare/0.21.0...0.22.0
1305-
[0.21.0]: https://github.com/square/Listable/compare/0.20.2...0.21.0
1306-
[0.20.2]: https://github.com/square/Listable/compare/0.20.1...0.20.2
1307-
[0.20.1]: https://github.com/square/Listable/compare/0.20.0...0.20.1
1308-
[0.20.0]: https://github.com/square/Listable/compare/0.19.0...0.20.0
1309-
[0.19.0]: https://github.com/square/Listable/compare/0.18.0...0.19.0
1310-
[0.18.0]: https://github.com/square/Listable/compare/0.17.0...0.18.0
1311-
[0.17.0]: https://github.com/square/Listable/compare/0.16.0...0.17.0
1312-
[0.16.0]: https://github.com/square/Listable/compare/0.15.1...0.16.0
1313-
[0.15.1]: https://github.com/square/Listable/compare/0.15.0...0.15.1
1314-
[0.15.0]: https://github.com/square/Listable/compare/0.14.2...0.15.0
1315-
[0.14.1]: https://github.com/square/Listable/compare/0.14.1...0.14.2
1316-
[0.14.1]: https://github.com/square/Listable/compare/0.13.0...0.14.1
1317-
[0.13.0]: https://github.com/square/Listable/compare/0.12.1...0.13.0
1318-
[0.12.1]: https://github.com/square/Listable/compare/0.12.0...0.12.1
1319-
[0.12.0]: https://github.com/square/Listable/compare/0.11.0...0.12.0
1320-
[0.11.0]: https://github.com/square/Listable/compare/0.10.1...0.11.0
1321-
[0.10.1]: https://github.com/square/Listable/compare/0.10.0...0.10.1
1322-
[0.10.0]: https://github.com/square/Listable/compare/0.9.0...0.10.0

RELEASING.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@
66

77
1. Update localized strings. Find the sha of the latest commit with `git log`, then run `./Scripts/install_localized_strings.sh [sha]` to download the latest translations.
88

9-
1. Update the library version in `version.rb` if it has not already been updated (it should match the version number that you are about to release).
10-
119
1. Update `CHANGELOG.md` (in the root of the repo), moving current changes under `Main` to a new section under `Past Releases` for the version you are releasing.
12-
13-
The changelog uses [reference links](https://daringfireball.net/projects/markdown/syntax#link) to link each version's changes. Remember to add a link to the new version at the bottom of the file, and to update the link to `[main]`.
1410

1511
1. Re-generate the documentation.
1612
```bash
@@ -19,14 +15,15 @@
1915

2016
1. Commit the version bumps and doc changes.
2117
```bash
22-
git commit -am "Bumping versions to 0.1.0."
18+
git commit -am "Bumping version to 0.1.0"
2319
```
2420

2521
1. Push your branch and open a PR into `main`.
2622

27-
1. Once the PR is merged, fetch changes and tag the release, using the merge commit:
28-
```bash
29-
git fetch
30-
git tag 0.1.0 <merge commit SHA>
31-
git push origin 0.1.0
32-
```
23+
1. Go to the [Releases](https://github.com/square/Listable/releases) and `Draft a new release`.
24+
25+
1. In the release notes, copy the changes from the changelog.
26+
27+
1. Ensure the `Title` corresponds to the version we're publishing.
28+
29+
1. Merge the PR, then hit `Publish release`.

Scripts/release.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
#!/bin/bash
22
set -e
33

4+
echo "TODO: Update this script to use the new release process."
5+
echo "Use the manual steps in RELEASING.md for now."
6+
exit 0
7+
48
# Release script for Listable
59
# This script automates the steps in RELEASING.md
610

0 commit comments

Comments
 (0)