Starter project: Convert release notes into something useful


(Radek Pietruszewski) #1

If someone wants to tackle the “archeology exercise”, those might help :slight_smile:

- SwiftInFlux has Xcode 6.1/Swift 1.1 history pretty well preserved: https://github.com/ksm/SwiftInFlux#changed-in-xcode-611 (unfortunately the project died down before Swift 2 came around)
- I have a copy of almost all Xcode 6—Xcode 7.1 Release Notes I can share privately on request

— Radek

···

We have this document, which captures some of the evolution of swift over time in the form of release notes:
https://github.com/apple/swift/blob/master/utils/buildbot-release-notes.txt

We’ve started updating it for behavior changes in Swift 2.2, and think that something like it is important so that when we do a release, we have a way to make sure that sometime important isn’t missed. Users like to know what’s new :slight_smile:

That said, it has two pretty serious problems:
- It is missing content on what happened between Oct 2014 and the start of the Swift 2.2 cycle.
- It is a weird little text file off in an undiscoverable place in the source tree.

Fixing the former problem is a bit of an archeology exercise, the later problem is more of a content/design problem. Is anyone interested in tackling either of these?

-Chris


(joe) #2

Now that the CHANGELOG.md file is in place, I can take a look at the "archeology exercise" bit. The updates to the Xcode release notes for official releases are online (https://developer.apple.com/library/ios/releasenotes/DeveloperTools/RN-Xcode/Chapters/Introduction.html), but Radek, if you have the beta release notes handy, those may be useful in creating more granular updates to the changelog.

It won't be too difficult to pull out the sections relevant to Swift from the Xcode release notes, but is that what we want in the CHANGELOG? I want to make sure it's ok to have the duplicated content added, or if the purpose of the CHANGELOG might be somewhat different than Xcode's release notes (at least the sections pertaining the Swift language itself).

···

On Dec 6, 2015, at 5:53 AM, Radosław Pietruszewski via swift-dev <swift-dev@swift.org> wrote:

If someone wants to tackle the “archeology exercise”, those might help :slight_smile:

- SwiftInFlux has Xcode 6.1/Swift 1.1 history pretty well preserved: https://github.com/ksm/SwiftInFlux#changed-in-xcode-611 (unfortunately the project died down before Swift 2 came around)
- I have a copy of almost all Xcode 6—Xcode 7.1 Release Notes I can share privately on request

— Radek

We have this document, which captures some of the evolution of swift over time in the form of release notes:

https://github.com/apple/swift/blob/master/utils/buildbot-release-notes.txt

We’ve started updating it for behavior changes in Swift 2.2, and think that something like it is important so that when we do a release, we have a way to make sure that sometime important isn’t missed. Users like to know what’s new :slight_smile:

That said, it has two pretty serious problems:
- It is missing content on what happened between Oct 2014 and the start of the Swift 2.2 cycle.
- It is a weird little text file off in an undiscoverable place in the source tree.

Fixing the former problem is a bit of an archeology exercise, the later problem is more of a content/design problem. Is anyone interested in tackling either of these?

-Chris

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev


(joe) #3

Nm my question about the duplicated content, I just noticed after starting to look into this that some of the notes in the Xcode release notes are the same as in the CHANGELOG. I'll get started on adding the missing content.

···

On Dec 7, 2015, at 4:21 PM, joe via swift-dev <swift-dev@swift.org> wrote:

Now that the CHANGELOG.md file is in place, I can take a look at the "archeology exercise" bit. The updates to the Xcode release notes for official releases are online (https://developer.apple.com/library/ios/releasenotes/DeveloperTools/RN-Xcode/Chapters/Introduction.html), but Radek, if you have the beta release notes handy, those may be useful in creating more granular updates to the changelog.

It won't be too difficult to pull out the sections relevant to Swift from the Xcode release notes, but is that what we want in the CHANGELOG? I want to make sure it's ok to have the duplicated content added, or if the purpose of the CHANGELOG might be somewhat different than Xcode's release notes (at least the sections pertaining the Swift language itself).

On Dec 6, 2015, at 5:53 AM, Radosław Pietruszewski via swift-dev <swift-dev@swift.org> wrote:

If someone wants to tackle the “archeology exercise”, those might help :slight_smile:

- SwiftInFlux has Xcode 6.1/Swift 1.1 history pretty well preserved: https://github.com/ksm/SwiftInFlux#changed-in-xcode-611 (unfortunately the project died down before Swift 2 came around)
- I have a copy of almost all Xcode 6—Xcode 7.1 Release Notes I can share privately on request

— Radek

We have this document, which captures some of the evolution of swift over time in the form of release notes:

https://github.com/apple/swift/blob/master/utils/buildbot-release-notes.txt

We’ve started updating it for behavior changes in Swift 2.2, and think that something like it is important so that when we do a release, we have a way to make sure that sometime important isn’t missed. Users like to know what’s new :slight_smile:

That said, it has two pretty serious problems:
- It is missing content on what happened between Oct 2014 and the start of the Swift 2.2 cycle.
- It is a weird little text file off in an undiscoverable place in the source tree.

Fixing the former problem is a bit of an archeology exercise, the later problem is more of a content/design problem. Is anyone interested in tackling either of these?

-Chris

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev


(Chris Lattner) #4

Nm my question about the duplicated content, I just noticed after starting to look into this that some of the notes in the Xcode release notes are the same as in the CHANGELOG. I'll get started on adding the missing content.

Sounds great, thanks Joe. Someone contributed a slightly modified version of the Xcode release notes, which helped round them out, but lots of details (and resolution on when things went in) are missing.

-Chris

···

On Dec 7, 2015, at 4:21 PM, joe via swift-dev <swift-dev@swift.org> wrote:

On Dec 7, 2015, at 4:21 PM, joe via swift-dev <swift-dev@swift.org> wrote:

Now that the CHANGELOG.md file is in place, I can take a look at the "archeology exercise" bit. The updates to the Xcode release notes for official releases are online (https://developer.apple.com/library/ios/releasenotes/DeveloperTools/RN-Xcode/Chapters/Introduction.html), but Radek, if you have the beta release notes handy, those may be useful in creating more granular updates to the changelog.

It won't be too difficult to pull out the sections relevant to Swift from the Xcode release notes, but is that what we want in the CHANGELOG? I want to make sure it's ok to have the duplicated content added, or if the purpose of the CHANGELOG might be somewhat different than Xcode's release notes (at least the sections pertaining the Swift language itself).

On Dec 6, 2015, at 5:53 AM, Radosław Pietruszewski via swift-dev <swift-dev@swift.org> wrote:

If someone wants to tackle the “archeology exercise”, those might help :)

- SwiftInFlux has Xcode 6.1/Swift 1.1 history pretty well preserved: https://github.com/ksm/SwiftInFlux#changed-in-xcode-611 (unfortunately the project died down before Swift 2 came around)
- I have a copy of almost all Xcode 6—Xcode 7.1 Release Notes I can share privately on request

— Radek

We have this document, which captures some of the evolution of swift over time in the form of release notes:

https://github.com/apple/swift/blob/master/utils/buildbot-release-notes.txt

We’ve started updating it for behavior changes in Swift 2.2, and think that something like it is important so that when we do a release, we have a way to make sure that sometime important isn’t missed. Users like to know what’s new :-)

That said, it has two pretty serious problems:
- It is missing content on what happened between Oct 2014 and the start of the Swift 2.2 cycle.
- It is a weird little text file off in an undiscoverable place in the source tree.

Fixing the former problem is a bit of an archeology exercise, the later problem is more of a content/design problem. Is anyone interested in tackling either of these?

-Chris

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev

_______________________________________________
swift-dev mailing list
swift-dev@swift.org
https://lists.swift.org/mailman/listinfo/swift-dev