Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOG for 1.1 #174

Merged
merged 5 commits into from
Apr 30, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
## Installation/Updating

To install Subliminal see the [installation walkthrough](https://github.com/inkling/Subliminal/wiki#installing-subliminal)
on the wiki.

To update Subliminal:
* If you installed Subliminal **manually**, download Subliminal [from the Releases page](https://github.com/inkling/Subliminal/releases)
and drop in the new sources.
* If you installed Subliminal **using Git submodules**, execute `git checkout <tag>` from
Subliminal's root directory and commit your change in your project.
* If you installed Subliminal **using Cocoapods**, update your Podfile (optional) and then
execute `pod update Subliminal` from your project directory.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cocoapods just added a new feature where you can run pod update POD_NAME to update just that pod; with just pod update it would update every pod that wasn't bounded by version constraints

(Other than that unchanged from what you wrote)


Then, to update your installation of Subliminal's docs (if desired), execute `rake install` from
Subliminal's root directory (if you installed Subliminal manually or using Git submodules) or
from `YOUR_PROJECT_DIR/Pods/Subliminal` (if you installed Subliminal using Cocoapods).

_Please also see the notes below for release-specific update instructions._

## Master

## 1.1

[Complete diff](https://github.com/inkling/Subliminal/compare/1.0.1...1.1)

_Because of the significant period of time between the 1.0.1 and 1.1 releases, the 1.1 changelog is heavily abridged._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good note


##### Updated Requirements

* Subliminal now requires Xcode 5.1. iOS 5.1 is still supported, though this is the last release
to support iOS 5.1. To test in the iOS 5.1 Simulator, users must run OS X 10.8 and manually
add the iOS 5.1 Simulator to Xcode as described [here](http://stackoverflow.com/a/22494536/495611).
* Subliminal no longer requires the user's password to run from the command-line. Users
should stop passing the `-login_password` and `--live` options to the `subliminal-test` script
and instead [pre-authorize their computers to run Instruments](https://github.com/inkling/Subliminal/wiki/Continuous-Integration#faq).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this where you wanted to put this? I know you said "at the top" but the install/updating instructions you wrote say "see the notes below for release-specific update instructions", so I wasn't 100% sure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


##### Notable Features

* Subliminal no longer requires the user's password to run from the command line.
[Jeffrey Wear](https://github.com/wearhere) [#181](https://github.com/inkling/Subliminal/pull/181)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this entry should specifically call out -login_password and --live as being deprecated?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good idea to mention that--though I think it might be even nicer to put that up at the top somehow? The most important things for developers to know are "what this release requires of them", both that they move away from -login_password/--live (soft requirement) and that they use Xcode 5.1 (hard requirement).

We should also mention that they can still use iOS 5.1 (see the README), but that this will be the last release to support doing so. (When I tag 1.1 I'll update that part of the README btw.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, at the top we should put

##### Updated Requirements

* Subliminal now requires Xcode 5.1. iOS 5.1 is still supported, though this is the last release
to support iOS 5.1. To test in the iOS 5.1 Simulator, users must run OS X 10.8 and manually
add the iOS 5.1 Simulator to Xcode as described [here](http://stackoverflow.com/a/22494536/495611).
* Subliminal no longer requires the user's password to run from the command-line. Users
should stop passing the `-login_password` and `--live` options to the `subliminal-test` script
and instead [pre-authorize their computers to run Instruments](https://github.com/inkling/Subliminal/wiki/Continuous-Integration#faq).

And then we can amend line 15 (#181's line item) to simply read "Subliminal no longer requires the user's password to run from the command line."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good organization, good thinking


* Use Instrument's new `-w` flag to run on a specific device
[Jeffrey Wear](https://github.com/wearhere) [#181](https://github.com/inkling/Subliminal/pull/181)

* Cocoapods support
[Max Tagher](https://github.com/MaxGabriel) [#30](https://github.com/inkling/Subliminal/pull/30)

* Pretty-printed test output
[Jeffrey Wear](https://github.com/wearhere) [#134](https://github.com/inkling/Subliminal/pull/134)

* Randomized test order
[Jeffrey Wear](https://github.com/wearhere) [#80](https://github.com/inkling/Subliminal/pull/80)

* Support testing on a device without the app having already been installed
[Jeffrey Wear](https://github.com/wearhere) [#75](https://github.com/inkling/Subliminal/pull/75)

* Support retina devices
[Nikita Zhuk](https://github.com/nzhuk) [#45](https://github.com/inkling/Subliminal/pull/45)

###### New SLElement subclasses

* SLSwitch
[Justin Mutter](https://github.com/j-mutter) [#85](https://github.com/inkling/Subliminal/pull/85)

* SLStatusBar
[Leon Jiang](https://github.com/leoninkling) [#55](https://github.com/inkling/Subliminal/pull/55)

* SLWebTextView
[Jeffrey Wear](https://github.com/wearhere) [#49](https://github.com/inkling/Subliminal/pull/49)

* SLTextView
[Jeffrey Wear](https://github.com/wearhere) [#49](https://github.com/inkling/Subliminal/pull/49)

###### Other API additions

* Screenshot any SLElement
[Jordan Zucker](https://github.com/jzucker2) [#129](https://github.com/inkling/Subliminal/pull/129)

* Capture screenshots
[Jeffrey Wear](https://github.com/wearhere) [#118](https://github.com/inkling/Subliminal/pull/118)

* Double tap elements
[Jeffrey Wear](https://github.com/wearhere) [#121](https://github.com/inkling/Subliminal/pull/121)

* Custom Keyboard Support
[Justin Mutter](https://github.com/j-mutter) [#105](https://github.com/inkling/Subliminal/pull/105)

* Type characters that require tapping and holding
[Aaron Golden](https://github.com/aegolden) [#95](https://github.com/inkling/Subliminal/pull/95)

* Tap an element's activation point
[Jeffrey Wear](https://github.com/wearhere) [#61](https://github.com/inkling/Subliminal/pull/61)

* Check if an element has keyboard focus
[Jeffrey Wear](https://github.com/wearhere) [#49](https://github.com/inkling/Subliminal/pull/49)

* Touch and hold `SLElement`s
[Aaron Golden](https://github.com/aegolden) [#44](https://github.com/inkling/Subliminal/pull/44)



##### Notable bug fixes

* Workaround `isVisible` not working in non-portrait orientations
[Jeffrey Wear](https://github.com/wearhere) [#180](https://github.com/inkling/Subliminal/pull/180)

* Fix interacting with collection view cell contents by including mock views in the accessibility path
[Jeffrey Wear](https://github.com/wearhere) [#179](https://github.com/inkling/Subliminal/pull/179)

* Detect the simulator launching in an inconsistent state (Travis CI Stability improvement)
[Jeffrey Wear](https://github.com/wearhere) [#148](https://github.com/inkling/Subliminal/pull/148)

* Guard against `nil` in `accessibilityElementAtIndex:`
[Chad Etzel](https://github.com/jazzychad) [#125](https://github.com/inkling/Subliminal/pull/125)

* Search for the deepest element within the element hierarchy (iOS 7 fix)
[Nanouk](https://github.com/j2bbayle) [#116](https://github.com/inkling/Subliminal/pull/116)