Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit498e94b

Browse files
committed
Merge remote-tracking branch 'origin/master' into fix-possible-confusion-in-content-guides-getting-started
2 parents977e55c +e19e63c commit498e94b

File tree

68 files changed

+1680
-385
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1680
-385
lines changed
File renamed without changes.

‎.rvmrc‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ bundle exec nanoc -h
2222

2323
Nanoc has[some nice documentation](http://nanoc.ws/docs/tutorial/) to get you started. Though if you're mainly concerned with editing or adding content, you won't need to know much about nanoc.
2424

25-
[nanoc]:http://nanoc.stoneship.org/
25+
[nanoc]:http://nanoc.ws/
2626

2727
##Styleguide
2828

@@ -77,8 +77,8 @@ Some actions return arrays. You can modify the JSON by passing a block:
7777

7878
###Terminal blocks
7979

80-
You can specify terminal blocks with`pre.terminal` elements. (It'd be
81-
nice ifMarkdown could do this more cleanly.)
80+
You can specify terminal blocks with`pre.terminal` elements. (It'd be nice if
81+
Markdown could do this more cleanly.)
8282

8383
```html
8484
<preclass="terminal">

‎content/changes/2014-09-23-one-more-week-before-the-add-team-member-api-breaking-change.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ created_at: 2014-09-23
55
author_name:jakeboxer
66
---
77

8-
**Update:2014-09-30:** In response to feedback from developers, we're delaying the breaking change to the["Add team member" API][add-team-member] until Monday,**October 6, 2014**. The change will go into effect for all requests on that date.
8+
**UPDATE (2014-09-30):** In response to feedback from developers, we're delaying the breaking change to the["Add team member" API][add-team-member] until Monday,**October 6, 2014**. The change will go into effect for all requests on that date.
99

1010
Starting October 6, if you use[the "Add team member" API][add-team-member] to add a user to a team and that user isn't already on another team in your organization, the request will fail. To avoid this, be sure to use the[the "Add team membership" API][add-team-membership].
1111

‎content/changes/2014-10-21-deployment-webhook-payload-changes.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ This change brings the payloads for these events more inline with the responses
4848
"sha": "deadbeef",
4949
"ref": "master",
5050
"task": "deploy",
51-
"name": "my-org/our-app",
5251
"environment": "production",
5352
"payload": {…},
5453
"description": "Deploying master",
@@ -72,7 +71,6 @@ This change brings the payloads for these events more inline with the responses
7271
"sha": "deadbeef",
7372
"ref": "master",
7473
"task": "deploy",
75-
"name": "my-org/our-app",
7674
"environment": "production",
7775
"payload": {…},
7876
"description": "Deploying master",
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
kind:change
3+
title:The Deployments API is official
4+
created_at:2014-11-25
5+
author_name:atmos
6+
---
7+
8+
We're happy to announce that the[Deployments API][docs] is officially part
9+
of GitHub API v3. We now consider it stable for production use.
10+
11+
Thanks to everyone who provided feedback during the preview period. We got
12+
some great feedback, and hope this feature helps you build the tools you
13+
need to make GitHub the best place to ship exactly the way you want.
14+
15+
###Preview media type no longer needed
16+
17+
If you used the Deployments API during the preview period, you needed to
18+
provide a custom media type in the`Accept` header:
19+
20+
application/vnd.github.cannonball-preview+json
21+
22+
Now that the preview period has ended, you no longer need to pass this custom
23+
media type.
24+
25+
Instead, we[recommend][media-types] that you specify`v3` as the version in the
26+
`Accept` header:
27+
28+
application/vnd.github.v3+json
29+
30+
###Feedback
31+
32+
We'll never be done listening to you! As always, please don't hesitate to
33+
[share your feedback][feedback].
34+
35+
[docs]:/v3/repos/deployments
36+
[media-types]:/v3/media
37+
[feedback]:https://github.com/contact?form[subject]=Deployments+API
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
kind:change
3+
title:Preview the New Organization Webhooks API
4+
created_at:2014-12-03
5+
author_name:jdpace
6+
---
7+
8+
Today we're very excited[to announce Organization Webhooks][dotcom-blog-post].
9+
Organization Webhooks allow you to subscribe to events that happen across an
10+
entire organization.
11+
12+
In addition to being able to subscribe to the existing repository oriented
13+
events across an organization, we're also adding some new events which are
14+
exclusive to organization webhooks. The new[`repository`
15+
event][repository-event] allows you to receive webhook payloads when a new
16+
repository is created. By subscribing to the[`membership`
17+
event][membership-event], you'll be notified whenever a user is added or
18+
removed from a team.
19+
20+
We’re making this new API for Organization Webhooks available today[for
21+
developers to preview][docs-preview]. The preview period will allow us to[get
22+
your feedback][contact] before declaring the Organization Webhooks API final.
23+
We expect the preview
24+
period to last for roughly 30-60 days.
25+
26+
As we discover opportunities to improve the API during the preview period, we
27+
may ship changes that break clients using the preview version of the API. We
28+
want to iterate quickly. To do so, we will announce any changes here (on the
29+
developer blog), but we will not provide any advance notice.
30+
31+
At the end of preview period, the Organization Webhooks API will become an
32+
official component of GitHub API v3. At that point, the new Organization
33+
Webhooks API will be stable and suitable for production use.
34+
35+
We hope you’ll take it for a spin and[send us your feedback][contact].
36+
37+
[dotcom-blog-post]:https://github.com/blog/1933-introducing-organization-webhooks
38+
[repository-event]:/v3/activity/events/types/#repositoryevent
39+
[membership-event]:/v3/activity/events/types/#membershipevent
40+
[docs]:/v3/orgs/hooks/
41+
[docs-preview]:/v3/orgs/hooks/#preview-period
42+
[contact]:https://github.com/contact?form[subject]=Organization+Webhooks
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
kind:change
3+
title:Preview the upcoming organization permission changes
4+
created_at:2014-12-08
5+
author_name:jakeboxer
6+
---
7+
**UPDATE (2014-12-12):** The[List your organizations][list-your-organizations] API is now included in this preview as well.
8+
9+
We have some upcoming changes that will affect the way organization members and repositories are managed. The most important changes are:
10+
11+
- The Owners team will no longer be special.
12+
- The[List your repositories][list-your-repos] API will include organization-owned repositories.
13+
- The[List user organizations][list-user-organizations] API will only include public organization memberships.
14+
- The[List your organizations][list-your-organizations] API will require`user` scope or`read:org` scope.
15+
16+
##What's happening to the Owners team?
17+
18+
Currently, members of your Owners team are administrators of your organization. Soon, your Owners team will become a totally normal team. Adding and removing Owners team members won't change their administrator status anymore. Instead, you'll be able to directly grant admin permissions to your organization's members without adding them to any special teams.
19+
20+
We won't delete your Owners team, but you'll be able to delete or rename it yourself if you want. Organizations created after the change won't have an Owners team.
21+
22+
###What should you do?
23+
24+
In preparation for this change to the Owners team, we're releasing a few new APIs. You'll be able to use these APIs to manage organization admins without relying on the Owners team.
25+
26+
####Adding an organization admin
27+
28+
To add a new organization admin, use the new[Add or update organization membership][add-org-membership] endpoint, specifying a role of`"admin"` in the request body. This replaces adding or inviting people to the Owners team.
29+
30+
####Removing an organization admin
31+
32+
To remove someone from the organization role but keep them as a member of their teams, use the new[Add or update organization membership][add-org-membership] endpoint, specifying a role of`"member"` in the request body. This replaces removing people from the Owners team.
33+
34+
####Listing organization admins
35+
36+
To get a list of all your organization's admins, use the[Organization members list][list-org-members] endpoint, specifying a role of`"admin"` in the query string. This replaces listing the members of the Owners team.
37+
38+
####Checking if someone is an organization admin
39+
40+
To check if a given user is an organization admin, use the new[Get organization membership][get-org-membership] endpoint. If the returned`"role"` attribute is set to`"admin"` and the returned`"state"` attribute is set to`"active"`, the user is an organization admin. This replaces checking if a user is on the Owners team.
41+
42+
##What's happening to the "List your repositories" API?
43+
44+
Currently, the[List your repositories][list-your-repos] API only returns repositories that are owned by users, not by organizations. If you want a list of*all* the repositories that the authenticated user has access to, you need to use multiple API methods.
45+
46+
Soon, this API will include all repositories that the authenticated user has access to (whether they're owned by a user or by an organization).
47+
48+
###What should you do?
49+
50+
Many apps use the[List your repositories][list-your-repos] API in conjunction with the[List your organizations][list-your-orgs] and[List organization repositories][list-org-repos] APIs to build up a list of all the repositories the authenticated user has access to. If your app is doing this, you'll be able to get rid of all the organization-related API calls and just use the[List your repositories][list-your-repos] API.
51+
52+
If your app uses the[List your repositories][list-your-repos] API for another purpose, you'll need to update your app to handle the new organization-owned repositories we'll be returning.
53+
54+
##What's happening to the "List user organizations" API?
55+
56+
The[List user organizations][list-user-organizations] API is intended provide[public organization memberships][public-org-membership] for any user. When you use this API to fetch*your own* organizations, this API currently returns your public and private organization memberships.
57+
58+
Soon, this API will only return public organization memberships.
59+
60+
###What should you do?
61+
62+
If your app uses the[List user organizations][list-user-organizations] API to fetch all of the organization memberships (public and private) for the authenticated user, you'll need to update your app to use the[List your organizations][list-your-organizations] API instead. The[List your organizations][list-your-organizations] API returns all organizations (public and private) that your app is authorized to access.
63+
64+
##What's happening to the "List your organizations" API?
65+
66+
OAuth requests will soon require minimum[scopes][] in order to access the[List your organizations][list-your-organizations] API.
67+
68+
Currently, the API response always includes your[public organization memberships][public-org-membership], regardless of the OAuth scopes associated with your request. If you have`user`,`read:org`,`write:org`, or`admin:org` scope, the response also includes your private organization memberships.
69+
70+
Soon, this API will only return organizations that your authorization allows you to operate on in some way (e.g., you can list teams with`read:org` scope, you can publicize your organization membership with`user` scope, etc.). Therefore, this API will require at least`user` or`read:org` scope. (`write:org` and`admin:org` scope implicitly include`read:org` scope.) OAuth requests with insufficient scope will receive a`403 Forbidden` response.
71+
72+
###What should you do?
73+
74+
If you[authenticate via username and password][username-password-authn], you are not affected by this change.
75+
76+
If your app only needs to fetch the user's public organization memberships, you should use the[List user organizations][list-user-organizations] API instead. Since that API only returns public information, it does not require any scopes.
77+
78+
##Preview period
79+
80+
Starting**today**, these new APIs are available for developers to preview. We expect the preview period to last for four weeks. (Stay tuned to the developer blog for updates.) At the end of the preview period, these additions will become official components of the GitHub API.
81+
82+
While these additions are in their preview period, you'll need to provide the following custom media type in the`Accept` header:
83+
84+
application/vnd.github.moondragon-preview+json
85+
86+
During the preview period, we may change aspects of these endpoints. If we do, we will announce the changes on the developer blog, but we will not provide any advance notice.
87+
88+
##Migration period
89+
90+
At the end of the preview period, we will announce the start of a migration period. At that time, developers should update their applications to use the new APIs for managing organization admins. During this period, you will still be able to use the Owners team to manage your organization's admins, so that you have time to update your applications to use the new APIs without breakage. We expect the migration period to last for four weeks.
91+
92+
At the end of the migration period, the Owners team will no longer be special, and you'll no longer be able to rely on it for managing organization admins.
93+
94+
If you have any questions or feedback, please[get in touch with us][contact]!
95+
96+
[contact]:https://github.com/contact?form[subject]=Organization+Admin+Pre-release+Preview
97+
[list-your-repos]:/v3/repos/#list-your-repositories
98+
[list-your-orgs]:/v3/orgs/#list-your-organizations
99+
[list-org-repos]:/v3/repos/#list-organization-repositories
100+
[add-org-membership]:/v3/orgs/members/#add-or-update-organization-membership
101+
[list-org-members]:/v3/orgs/members/#members-list
102+
[get-org-membership]:/v3/orgs/members/#get-organization-membership
103+
[list-user-organizations]:/v3/orgs/#list-user-organizations
104+
[list-your-organizations]:/v3/orgs/#list-your-organizations
105+
[public-org-membership]:https://help.github.com/articles/publicizing-or-concealing-organization-membership
106+
[username-password-authn]:/v3/auth/#via-username-and-password
107+
[scopes]:/v3/oauth/#scopes
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
kind:change
3+
title:Removing token attribute from Authorizations API responses
4+
created_at:2014-12-08
5+
author_name:ptoomey3
6+
---
7+
8+
Since OAuth access tokens function like passwords, they should be treated with
9+
care. Today we are making it easier to more securely work with authorizations
10+
via the Authorizations API. We are deprecating the use use of the`token`
11+
attribute in the majority of the[Authorizations API](/v3/oauth_authorizations/)
12+
responses. For the[affected APIs][authorizations-token-deprecation-notice], the
13+
`token` attribute will soon return an empty string. To get ready for that
14+
change, we are giving developers a chance to
15+
[preview the updated API](#preview-period) starting today.
16+
17+
##What's changing?
18+
19+
The current[OAuth Authorizations API](/v3/oauth_authorizations/) requires GitHub to store the full value for
20+
each OAuth token on our servers. In order to increase the security for our
21+
users, we are changing our architecture to store the SHA-256 digest of OAuth
22+
tokens instead. GitHub securely hashes user passwords using bcrypt and we want
23+
to provide comparable security for OAuth tokens as well.
24+
25+
Rest assured that this change is an entirely proactive measure from GitHub and is not associated with any security incident.
26+
27+
##Who is affected?
28+
29+
This change affects any code that relies on accessing the`token` attribute from
30+
[these OAuth Authorizations API responses][authorizations-token-deprecation-notice].
31+
For example, our own[GitHub for Mac][github-for-mac] and
32+
[GitHub for Windows][github-for-windows] applications relied on reading the`token`
33+
from the[Get-or-create an authorization for a specific app][get-or-create-for-app] API, in order to support multiple installations of our desktop application for a single user.
34+
35+
##What should you do?
36+
37+
In order to reduce the impact of removing the`token` attribute, the OAuth
38+
Authorizations API has added a new request attribute (`fingerprint`), added
39+
three new response attributes (`token_last_eight`,`hashed_token`, and
40+
`fingerprint`), and added[one new API][get-or-create-for-app-fingerprint].
41+
While these new APIs and attributes do not replace the full functionality that
42+
previously existed, they can be used in place of`token` for most common use cases.
43+
44+
*`token_last_eight` returns the last eight characters of the associated OAuth
45+
token. As an example,`token_last_eight` could be used to display a list of
46+
partial token values to help a user manage their OAuth tokens.
47+
48+
*`hashed_token` is the base64 of the SHA-256 digest of the token.
49+
`hashed_token` could be used to programmatically validate that a given token
50+
matches an authorization returned by the API.
51+
52+
*`fingerprint` is a new optional request parameter that allows an OAuth
53+
application to create multiple authorizations for a single user.`fingerprint`
54+
should be a string that distinguishes the new authorization from others
55+
for the same client ID and user.
56+
57+
For example, to differentiate installations of a desktop application across
58+
multiple devices you might set`fingerprint` to
59+
`SHA256_HEXDIGEST("GitHub for Mac - MAC_ADDRESS_OF_MACHINE")`. Since
60+
`fingerprint` is not meant to be a user-facing value, you should still set
61+
the`note` attribute to help a user differentiate between authorizations on their
62+
[OAuth applications listing on GitHub][app-listing].
63+
64+
*[Get-or-create an authorization for a specific app and fingerprint][get-or-create-for-app-fingerprint]
65+
is a new API that is analagous to the
66+
[Get-or-create an authorization for a specific app][get-or-create-for-app]
67+
API, but adds support for the new`fingerprint` request parameter.
68+
69+
##Preview period
70+
71+
We are making the new Authorizations API available today for developers to
72+
preview. During this period, we may change aspects of these endpoints. If we do,
73+
we will announce the changes on the developer blog, but we will not provide any
74+
advance notice.
75+
76+
While these new APIs are in their preview period, you’ll need to provide the
77+
following custom media type in the Accept header:
78+
79+
application/vnd.github.mirage-preview+json
80+
81+
We expect the preview period to last 4-6 weeks. (Stay tuned to the developer blog for updates.) At the end of the preview period, these changes will become an official and stable part of GitHub API.
82+
83+
##Migration period
84+
85+
At the end of the preview period, we will announce the start of a migration period. Developers will have 8 weeks to update existing code to use the new APIs.
86+
87+
##Why SHA-256 over bcrypt?
88+
89+
Some users may be curious why we are not using bcrypt to hash our OAuth tokens
90+
like we do for user passwords. Bcrypt is purposefully computationally expensive
91+
in order to mitigate brute force attacks against low entropy passwords. However,
92+
OAuth tokens are highly random and are not susceptible to brute force attacks.
93+
Given that OAuth token validation occurs for each request to the API we chose
94+
SHA-256 for performance reasons.
95+
96+
If you have any questions or feedback, please[drop us a line][contact].
97+
98+
[contact]:https://github.com/contact?form[subject]=Removing+authorizations+token
99+
[app-listing]:https://github.com/settings/applications
100+
[create-a-new-authorization]:/v3/oauth_authorizations/#create-a-new-authorization
101+
[get-or-create-for-app]:/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
102+
[get-or-create-for-app-fingerprint]:/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint
103+
[github-for-mac]:https://mac.github.com/
104+
[github-for-windows]:https://windows.github.com/
105+
[authorizations-token-deprecation-notice]:/v3/oauth_authorizations/#deprecation-notice
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
kind:change
3+
title:New Attributes for Starring API
4+
created_at:2014-12-09
5+
author_name:arfon
6+
---
7+
8+
You can now see when a user starred a repository. To receive the new response format containing the`starred_at` field, request the new media type:
9+
10+
curl -H "Accept: application/vnd.github.v3.star+json" https://api.github.com/users/andrew/starred
11+
12+
Note the starred repository is now available in the repo field.
13+
14+
###Feedback
15+
16+
If you have any questions or feedback about these changes, please[drop us a line][contact].
17+
18+
[starring]:/v3/activity/starring/#list-repositories-being-starred-with-star-creation-timestamps
19+
[contact]:https://github.com/contact?form[subject]=New+Attributes+for+Starring+API

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp