Sync changes from upstream repository

Hubot · Hubot · commit b9d728892704 · 2016-03-15T15:22:06.000-07:00
diff --git a/content/changes/2016-03-15-new-webhook-actions.md b/content/changes/2016-03-15-new-webhook-actions.md
@@ -0,0 +1,53 @@
+---
+title: New webhook event actions are coming
+author_name: davidcelis
+---
+
+We will soon begin introducing new `action` values for several existing webhook events. If you currently subscribe to webhooks but do not check the payload's `action` value, you may end up incorrectly processing events after this change is released. To ensure that your webhook processing is not affected by these new `action` values, **you should audit your webhook processing logic by April 15th, 2016**.
+
+We are providing an advance notice to warn of these changes. In the future, we may continue adding new actions without providing further warning.
+
+### A brief overview of GitHub webhook actions
+
+Webhook events can have multiple actions. For example, the [`IssuesEvent`](https://developer.github.com/v3/activity/events/types/#issuesevent) has several possible actions. These include `opened` when the issue is created, `closed` when the issue is closed, and `assigned` when the issue is assigned to someone. Historically, we haven't added new actions to webhook events that have only one action. However, as GitHub's feature set grows, we may occasionally add new actions to existing event types. We encourage you to take some time and ensure that your application explicitly checks the action before doing any processing.
+
+### What to avoid when working with event actions
+
+Here's an example of functionality that **will not work** when attempting to process an `IssuesEvent`. In this example, the `process_closed` method will be called for any event action which is not `opened` or `assigned`. This means that the `process_closed` method will be called for events with the `closed` action, but also other events with actions other than `opened` or `assigned` that are delivered to the webhook.
+
+```ruby
+# The following is not future-proof!
+case action
+when "opened"
+  process_opened
+when "assigned"
+  process_assigned
+else
+  process_closed
+end
+```
+
+### How to work with new event actions
+
+We suggest that you explicitly check event actions and act accordingly. In this example, the `closed` action is checked first before calling the `process_closed` method. Additionally, for unknown actions, we log that something new was encountered:
+
+```ruby
+# The following is recommended
+case action
+when "opened"
+  process_opened
+when "assigned"
+  process_assigned
+when "closed"
+  process_closed
+else
+  puts "Ooohh, something new from GitHub!"
+end
+```
+
+We may also add new webhook event types from time to time. If your webhook is configured to "Send me **everything**", your code should also explicitly check for the event type in a similar way as we have done with checking for the action type above. Take a look at our [integrators best practices guide][best-practices] for more tips.
+
+If you have any questions or feedback, please [get in touch][get-in-touch].
+
+[best-practices]: https://developer.github.com/guides/best-practices-for-integrators/
+[get-in-touch]: https://github.com/contact?form[subject]=New+Webhook+Actions
diff --git a/layouts/includes/pagination_bar.html b/layouts/includes/pagination_bar.html
@@ -1,4 +1,4 @@
-<!-- @count_gap refers to the minimum number of sibling pages to show -->
+<%# @count_gap refers to the minimum number of sibling pages to show %>
 <% @count_gap = 2; @i = 1; @total_pages = total_pages; %>
 <div class="pagination">
   <% if @current_page > 1 %>
@@ -7,14 +7,13 @@
   <span class="disabled">Previous</span>
   <% end %>
 
-  <!-- using a while loop here as it's the only way to skip several iterations -->
   <% while @i <= @total_pages do %>
     <% @gap = false %>
-    <!-- first half ensures we're not caught in an infinite loop at @total_pages - 1 -->
-    <!-- second half, with the .abs, checks for gap siblings ahead *and* behind the current page -->
+    <%# first half ensures we're not caught in an infinite loop at @total_pages - 1 %>
+    <%# second half, with the .abs, checks for gap siblings ahead *and* behind the current page %>
     <% if @i < (@total_pages - 1) && (@i - @current_page).abs > @count_gap %>
       <% @gap = true %>
-      <!-- we skip multiple iterations to insert the gap (`...`), and continue with the regular links -->
+      <%# we skip multiple iterations to insert the gap (`...`), and continue with the regular links %>
       <% @i = (@i < @current_page ? @current_page - @count_gap : @total_pages - 1) - 1 %>
     <% end %>
 
diff --git a/lib/changes_helper.rb b/lib/changes_helper.rb
@@ -42,7 +42,7 @@ def paginated_api_changes(first, last, version = nil)
   end
 
   def total_pages(version = nil)
-    (api_changes(version).length / PER_PAGE).floor + 1
+    (api_changes(version).length / PER_PAGE).floor
   end
 
   # Public
