github · mirrorzimage · Sep 28, 2012 · Oct 2, 2012 · Oct 2, 2012 · Oct 3, 2012
diff --git a/README.md b/README.md
@@ -53,13 +53,17 @@ We specify the JSON responses in ruby so that we don't have to write
 them by hand all over the docs.  You can render the JSON for a resource
 like this:
 
-    <%= json :issue %>
+```erb
+<%= json :issue %>
+```
 
 This looks up `GitHub::Resources::ISSUE` in `lib/resources.rb`.
 
 Some actions return arrays.  You can modify the JSON by passing a block:
 
-    <%= json(:issue) { |hash| [hash] } %>
+```erb
+<%= json(:issue) { |hash| [hash] } %>
+```
 
 ### Terminal blocks
 

diff --git a/Rakefile b/Rakefile
@@ -5,8 +5,23 @@ task :compile do
   `nanoc compile`
 end
 
+# prompt user for a commit message; default: HEAD commit 1-liner
+def commit_message
+  last_commit = `git log -1 --pretty=format:"%s"`.chomp.strip
+  last_commit = 'Publishing developer content to GitHub pages.' if last_commit == ''
+
+  print "Enter a commit message (default: '#{last_commit}'): "
+  STDOUT.flush
+  mesg = STDIN.gets.chomp.strip
+
+  mesg = last_commit if mesg == ''
+  mesg.gsub(/'/, '') # to allow this to be handed off via -m '#{message}'
+end
+
 desc "Publish to http://developer.github.com"
 task :publish => [:clean] do
+  mesg = commit_message
+
   FileUtils.rm_r('output') if File.exist?('output')
 
   sh "nanoc compile"
@@ -21,9 +36,9 @@ task :publish => [:clean] do
     tsha = `git write-tree`.strip
     puts "Created tree   #{tsha}"
     if old_sha.size == 40
-      csha = `echo 'boom' | git commit-tree #{tsha} -p #{old_sha}`.strip
+      csha = `git commit-tree #{tsha} -p #{old_sha} -m '#{mesg}'`.strip
     else
-      csha = `echo 'boom' | git commit-tree #{tsha}`.strip
+      csha = `git commit-tree #{tsha} -m '#{mesg}'`.strip
     end
     puts "Created commit #{csha}"
     puts `git show #{csha} --stat`

diff --git a/content/changes/2012-10-14-rate-limit-changes.html b/content/changes/2012-10-14-rate-limit-changes.html
@@ -0,0 +1,24 @@
+---
+kind: change
+title: Rate limit changes for unauthenticated requests
+created_at: 2012-10-14
+author_name: pengwynn
+---
+
+To ensure a high quality of service for all API consumers, we've reduced the
+default rate limit for unauthenticated requests. To enjoy the default rate
+limit of 5,000 requests per hour, you'll need to
+[authenticate](http://developer.github.com/v3/#authentication) via Basic Auth
+or OAuth. Unauthenticated requests will be limited to 60 per hour unless you
+[include your OAuth client and
+secret](http://developer.github.com/v3/#unauthenticated-rate-limited-requests).
+
+We'll soon require all requests to include a valid [User Agent
+header](http://en.wikipedia.org/wiki/User_agent). Setting a
+unique value for this header helps us identify requests and get in touch with
+developers who are abusing the API. Most HTTP libraries, wrapper libraries, and
+even cURL provide a valid header for you already and allow you to change it to
+something unique to your application.
+
+If you have any questions or feedback, please drop us a line at
+[support@github.com](mailto:support@github.com?subject=API Rate limit).
diff --git a/content/changes/2012-10-17-org-members-redirection.md b/content/changes/2012-10-17-org-members-redirection.md
@@ -0,0 +1,26 @@
+---
+kind: change
+title: Organization Members Resource Changes
+created_at: 2012-10-17
+author_name: pezra
+---
+
+Requesting the [member list](/v3/orgs/members/index.html#members-list) of an
+organization of which you are not a member now redirects to the [public members
+list](v3/orgs/members/index.html#public-members-list). Similarly, requests to
+[membership check](/v3/orgs/members/index.html#check-membership) resources of
+an organization of which you are not a member are redirected to the equivalent
+[public membership check](/v3/orgs/members/index.html#check-public-membership).
+One exception to the latter case is that if you are checking about your own
+membership the request is not redirected. You are always allowed to know what
+organizations you belong to.
+
+The changes where made to clarify the purpose of these various resources. The
+`/orgs/:org/members` resources are intended for use by members of the
+organization in question. The `/orgs/:org/public_members` resources are for
+acquiring information about the public membership of organizations. If you are
+not a member you are not allowed to see private membership information so you
+should be using the public membership resources.
+
+If you have any questions or feedback, please drop us a line at
+[support@github.com](mailto:support@github.com?subject=Org members API).
diff --git a/content/changes/2012-10-24-set-default-branch.html b/content/changes/2012-10-24-set-default-branch.html
@@ -0,0 +1,22 @@
+---
+kind: change
+title: Set the default branch for a repository
+created_at: 2012-10-24
+author_name: pengwynn
+---
+
+You can set the default branch for a repository to something other than 'master' from the GitHub repository admin screen:
+
+![repo admin](/images/posts/default-branch.png)
+
+Now, you can update this setting via the API. We've added a `default_branch` parameter to the [Edit Repository method][edit-repo]:
+
+<pre class="terminal">
+curl -u pengwynn \
+     -d '{"name": "octokit", "default_branch":"development"}' \
+     https://api.github.com/repos/pengwynn/octokit
+</pre>
+
+If you provide a branch name that hasn't been pushed to GitHub, we'll gracefully fall back to `'master'` or the first branch.
+
+[edit-repo]: /v3/repos/#edit
diff --git a/content/changes/2012-10-26-notifications-api.md b/content/changes/2012-10-26-notifications-api.md
@@ -0,0 +1,72 @@
+---
+kind: change
+title: Notifications API
+created_at: 2012-10-26
+author_name: technoweenie
+---
+
+Now that the dust has settled around [Notifications and Stars][newsies],
+we've unleashed all that :sparkles: in a [brand new API][api].  You can now
+view and mark notifications as read.
+
+[api]: http://developer.github.com/v3/activity/notifications/
+[newsies]: https://github.com/blog/1204-notifications-stars
+
+## Endpoint
+
+The core notifications functionality is under the `/notifications` endpoint.
+You can look for unread notifications:
+
+<pre class="terminal">
+$ curl https://api.github.com/notifications
+</pre>
+
+You can filter these notifications to a single Repository:
+
+<pre class="terminal">
+$ curl https://api.github.com/repos/technoweenie/faraday/notifications
+</pre>
+
+You can mark them as read:
+
+<pre class="terminal">
+# all notifications
+$ curl https://api.github.com/notifications \
+    -X PUT -d '{"read": true}'
+
+# notifications for a single repository
+$ curl https://api.github.com/repos/technoweenie/faraday/notifications \
+    -X PUT -d '{"read": true}'
+</pre>
+
+You can also modify subscriptions for a Repository or a single thread.
+
+<pre class="terminal">
+# subscription details for the thread (either an Issue or Commit)
+$ curl https://api.github.com/notifications/threads/1/subscription
+
+# subscription details for a whole Repository.
+$ curl https://api.github.com/repos/technoweenie/faraday/subscription
+</pre>
+
+## Polling
+
+The Notifications API is optimized for polling by the last modified time:
+
+<pre class="terminal">
+# Add authentication to your requests
+$ curl -I https://api.github.com/notifications
+HTTP/1.1 200 OK
+Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT
+X-Poll-Interval: 60
+
+# Pass the Last-Modified header exactly
+$ curl -I https://api.github.com/notifications
+    -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT"
+HTTP/1.1 304 Not Modified
+X-Poll-Interval: 60
+</pre>
+
+You can read about the API details in depth in the [Notifications documentation][api].
+
+
diff --git a/content/changes/2012-10-31-gist-comment-uris.md b/content/changes/2012-10-31-gist-comment-uris.md
@@ -0,0 +1,12 @@
+---
+kind: change
+title: Gist comment URIs
+created_at: 2012-10-31
+author_name: pezra
+---
+
+The URIs of all gist comments are changing immediately. The new URI pattern for gist comments is `/gists/{gist-id}/comments/{id}`. (See [gist comments section of the docs](/v3/gists/comments/) for more details.) This change is necessary because the auto-incremented ids of gist comments are easy to guess. This predictability allows anyone to view comments on private Gists with relative ease. Obviously, comments on private gists should be just as private as the gist itself.
+
+Adding the gist id to the URI of comments makes it impossible, in practical terms, to guess that URI because the id of private gists are very large random numbers. This is, unfortunately, a breaking change but one that cannot be avoided because of the security implications of the current URIs. We apologize for the inconvenience.
+
+We have also added a `comments_url` member to the Gist documents. The `comments_url` link provides access to the comments of a Gist in a way that will insulate clients from changes in the URI patterns used by the GitHub API. We are increasing our use of links in order to make changes such as this one less damaging to clients. We strongly encourage using `url` and `*_url` properties, where possible, rather than constructing URIs using the patterns published on this site. Doing so will result in clients that break less often.
diff --git a/content/changes/2012-11-27-forking-to-organizations.html b/content/changes/2012-11-27-forking-to-organizations.html
@@ -0,0 +1,29 @@
+---
+kind: change
+title: Forking to Organizations
+created_at: 2012-11-27
+author_name: technoweenie
+---
+
+We made a slight change to the way you fork a repository.  By default, you
+can fork my repository through an HTTP POST to the repository's fork resource.
+
+    $ curl -X POST https://api.github.com/repos/technoweenie/faraday/forks
+
+This repository forks to your personal account.  However, there are cases when
+you want to fork to one of your organizations instead.  The previous method
+required a `?org` query parameter:
+
+    $ curl -X POST /repos/technoweenie/faraday/forks?org=mycompany
+
+Query parameters on POST requests are unusual in APIs, and definitely
+inconsistent with the rest of the GitHub API.  You should be able to post a
+JSON body like every other POST endpoint.  Now, you can!  Only, now we're
+calling the field `organization`.
+
+    $ curl /repos/technoweenie/faraday/forks?org=mycompany \
+      -d '{"organization": "mycompany"}'
+
+Don't worry, we are committed to maintaining the legacy behavior until the next
+major change of the GitHub API.
+
diff --git a/content/changes/2012-11-29-gitignore-templates.html b/content/changes/2012-11-29-gitignore-templates.html
@@ -0,0 +1,58 @@
+---
+kind: change
+title: Gitignore Templates API
+created_at: 2012-11-29
+author_name: pengwynn
+---
+
+We recently [made it easy][init-post] to initialize a repository when you create
+it [via the API][repo-create]. One of the options you can pass when creating a
+repository is `gitignore_template`. This value is the name of one of the
+templates from the the public [GitHub .gitignore repository][templates-repo].
+
+The [Gitignore Templates API][new-api] makes it easy to list those templates:
+
+    curl https://api.github.com/gitignore/templates
+
+    HTTP/1.1 200 OK
+
+    [
+      "Actionscript",
+      "Android",
+      "AppceleratorTitanium",
+      "Autotools",
+      "Bancha",
+      "C",
+      "C++",
+      ...
+
+If you'd like to view the source, you can also fetch a single template.
+
+    curl -H 'Accept: application/vnd.github.raw' \
+         https://api.github.com/gitignore/templates/Objective-C
+
+    HTTP/1.1 200 OK
+
+    # Xcode
+    .DS_Store
+    build/
+    *.pbxuser
+    !default.pbxuser
+    *.mode1v3
+    !default.mode1v3
+    *.mode2v3
+    !default.mode2v3
+    *.perspectivev3
+    !default.perspectivev3
+    *.xcworkspace
+    !default.xcworkspace
+    xcuserdata
+    profile
+    *.moved-aside
+    DerivedData
+    .idea/
+
+[init-post]: /changes/2012-9-28-auto-init-for-repositories/
+[repo-create]: /v3/repos/#create
+[templates-repo]: https://github.com/github/gitignore
+[new-api]: /v3/gitignore/
diff --git a/content/changes/2012-12-04-List-comments-for-repo.html b/content/changes/2012-12-04-List-comments-for-repo.html
@@ -0,0 +1,26 @@
+---
+kind: change
+title: Per-repository Review and Issue Comment&nbsp;listing
+created_at: 2012-12-04
+author_name: pengwynn
+---
+
+You've always been able to grab all the commit comments for an entire
+repository via the API, but to get Issue comments and Pull Request Review
+Comments, you could only fetch the comments for a single Issue or Pull Request.
+
+Today, we're introducing two new methods to grab all Issue Comments and Review
+Comments for a repository.
+
+    # Grab all Issue Comments
+    curl https://api.github.com/repos/mathiasbynens/dotfiles/issues/comments
+
+    # Grab all Review Comments
+    curl https://api.github.com/repos/mathiasbynens/dotfiles/pulls/comments
+
+Check out the docs for sorting and filtering options:
+
+* [Issue comments](/v3/issues/comments/#list-comments-in-a-repository)
+* [Review comments](/v3/pulls/comments/#list-comments-in-a-repository)
+
+
diff --git a/content/changes/2012-12-06-create-authorization-for-app.html b/content/changes/2012-12-06-create-authorization-for-app.html
@@ -0,0 +1,38 @@
+---
+kind: change
+title: Create an OAuth authorization for an app
+created_at: 2012-12-06
+author_name: pengwynn
+---
+
+The [Authorizations API][oauth-api] is an easy way to create an OAuth
+authorization using Basic Auth. Just POST your desired scopes and optional
+note and you get a token back:
+
+<pre class='terminal'>
+    curl -u pengwynn -d '{"scopes": ["user", "gist"]}' \
+         https://api.github.com/authorizations
+</pre>
+
+This call creates a token for the authenticating user tied to a special "API"
+OAuth application.
+
+We now support creating tokens for _your own OAuth application_ by passing your
+twenty character `client_id` and forty character `client_secret` as found in
+the settings page for your OAuth application.
+
+
+<pre class='terminal'>
+    curl -u pengwynn -d '{ \
+                          "scopes": ["user", "gist"], \
+                          "client_id": "abcdeabcdeabcdeabcdeabcde" \
+                          "client_secret": "abcdeabcdeabcdeabcdeabcdeabcdeabcdeabcdeabcde" \
+                         }' \ '
+            https://api.github.com/authorizations
+</pre>
+
+No more implementing the [web flow][web-flow] just to get a token tied to your
+app's rate limit.
+
+[oauth-api]: /v3/oauth/#oauth-authorizations-api
+[web-flow]: /v3/oauth/#web-application-flow
diff --git a/content/changes/2012-12-08-finding-source-and-fork-repos-for-organizations.html b/content/changes/2012-12-08-finding-source-and-fork-repos-for-organizations.html
@@ -0,0 +1,23 @@
+---
+kind: change
+title: Finding sources and fork repositories for organizations
+created_at: 2012-12-08
+author_name: rick
+---
+
+We've made a couple of changes today to the Organization repositories
+listing to bring it a bit closer to the functionality of the GitHub.com
+Organization repositories tab.  We now let you retrieve repositories
+which are forks of another repo, as well as those repositories which
+are sources (not forks).
+
+    # Grab all fork Repositories for an Organization
+    curl "https://api.github.com/orgs/:org/repos?type=forks"
+
+    # Grab all source Repositories for an Organization
+    curl "https://api.github.com/orgs/:org/repos?type=sources"
+
+Check out the docs for sorting and filtering options:
+
+* [Organization Repositories](/v3/repos/#list-organization-repositories)
+