Merge branch 'master' into issue_546_list_repository_topics

Author: martinvanzijl

.github/release-drafter.yml

@@ -0,0 +1,19 @@
+name-template: 'v$NEXT_PATCH_VERSION 🌈'
+tag-template: 'v$NEXT_PATCH_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+template: |
+  ## Changes
+
+  $CHANGES

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

pom.xml

@@ -14,16 +14,16 @@
   <description>GitHub API for Java</description>
 
   <scm>
-    <connection>scm:git:[email protected]/kohsuke/${project.artifactId}.git</connection>
-    <developerConnection>scm:git:ssh://[email protected]/kohsuke/${project.artifactId}.git</developerConnection>
+    <connection>scm:git:[email protected]/github-api/${project.artifactId}.git</connection>
+    <developerConnection>scm:git:ssh://[email protected]/github-api/${project.artifactId}.git</developerConnection>
     <url>https://${project.artifactId}.kohsuke.org/</url>
     <tag>HEAD</tag>
   </scm>
 
   <distributionManagement>
     <site>
       <id>github-pages</id>
-      <url>gitsite:[email protected]/kohsuke/${project.artifactId}.git</url>
+      <url>gitsite:[email protected]/github-api/${project.artifactId}.git</url>
     </site>
   </distributionManagement>
 

src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java

@@ -35,7 +35,7 @@ public class GHAppCreateTokenBuilder {
      *
      */
     @Preview @Deprecated
-    public GHAppCreateTokenBuilder repositoryIds(List<Integer> repositoryIds) {
+    public GHAppCreateTokenBuilder repositoryIds(List<Long> repositoryIds) {
         this.builder.with("repository_ids",repositoryIds);
         return this;
     }

src/main/java/org/kohsuke/github/GHMilestone.java

@@ -85,10 +85,29 @@ public void reopen() throws IOException {
         edit("state", "open");
     }
 
+    /**
+     * Deletes this milestone.
+     */
+    public void delete() throws IOException {
+        root.retrieve().method("DELETE").to(getApiRoute());
+    }
+
     private void edit(String key, Object value) throws IOException {
         new Requester(root)._with(key, value).method("PATCH").to(getApiRoute());
     }
 
+    public void setTitle(String title) throws IOException {
+        edit("title", title);
+    }
+
+    public void setDescription(String description) throws IOException {
+        edit("description", description);
+    }
+
+    public void setDueOn(Date dueOn) throws IOException {
+        edit("due_on", GitHub.printDate(dueOn));
+    }
+
     protected String getApiRoute() {
         return "/repos/"+owner.getOwnerName()+"/"+owner.getName()+"/milestones/"+number;
     }

src/main/java/org/kohsuke/github/GHRepository.java

@@ -129,7 +129,7 @@ public PagedIterable<GHDeployment> listDeployments(String sha,String ref,String
      * Obtains a single {@link GHDeployment} by its ID.
      */
     public GHDeployment getDeployment(long id) throws IOException {
-        return root.retrieve().to("deployments/" + id, GHDeployment.class).wrap(this);
+        return root.retrieve().to(getApiTailUrl("deployments/" + id), GHDeployment.class).wrap(this);
     }
 
     private String join(List<String> params, String joinStr) {

src/main/java/org/kohsuke/github/GitHub.java

@@ -956,7 +956,9 @@ public Reader renderMarkdown(String text) throws IOException {
     }
 
     /*package*/ static String printDate(Date dt) {
-        return new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(dt);
+        SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
+        df.setTimeZone(TimeZone.getTimeZone("GMT"));
+        return df.format(dt);
     }
 
     /*package*/ static final ObjectMapper MAPPER = new ObjectMapper();

src/main/java/org/kohsuke/github/GitHubBuilder.java

@@ -180,6 +180,18 @@ public GitHubBuilder withOAuthToken(String oauthToken, String user) {
         this.user = user;
         return this;
     }
+
+    /**
+     * Configures {@link GitHubBuilder} with Installation Token generated by the GitHub Application
+     *
+     * @param appInstallationToken A string containing the GitHub App installation token
+     * @return the configured Builder from given GitHub App installation token.
+     * @see GHAppInstallation#createToken(java.util.Map)
+     */
+    public GitHubBuilder withAppInstallationToken(String appInstallationToken){
+        return withOAuthToken(appInstallationToken, "");
+    }
+
     public GitHubBuilder withJwtToken(String jwtToken){
         this.jwtToken = jwtToken;
         return this;

src/site/apt/index.apt

@@ -0,0 +1,154 @@
+What is this?
+
+  This library defines an object oriented representation of the GitHub API. By "object oriented" we mean
+  there are classes that correspond to the domain model of GitHub (such as <<<GHUser>>> and <<<GHRepository>>>),
+  operations that act on them as defined as methods (such as <<<GHUser.follow()>>>), and those object references
+  are used in favor of using string handle (such as <<<GHUser.isMemberOf(GHOrganization)>>> instead of
+  <<<GHUser.isMemberOf(String)>>>)
+
+  The library supports both github.com and GitHub Enterprise.
+
+  Most of the GitHub APIs are covered, although there are some corners that are still not yet implemented.
+
+Sample Usage
+
++-----+
+GitHub github = GitHub.connect();
+
+GHRepository repo = github.createRepository(
+  "new-repository","this is my new repository",
+  "http://www.kohsuke.org/",true/*public*/);
+repo.addCollaborators(github.getUser("abayer"),github.getUser("rtyler"));
+repo.delete();
++-----+
+
+Authentication
+
+  The library allows connecting to GitHub via several different authentication mechanisms.
+
+* Programmatically
+
+  To connect via Username and Password (not recommended):
+
++-----+
+GitHub github = new GitHubBuilder().withPassword("my_user", "my_passwd").build();
++-----+
+
+  To connect via Personal access token:
+
++-----+
+// If you don't specify the GitHub user id then the sdk will retrieve it via /user endpoint
+GitHub github = new GitHubBuilder().withOAuthToken("my_personal_token").build();
+
+// If the token has access to an organization, you can specify it here.
+GitHub github = new GitHubBuilder().withOAuthToken("my_personal_token","user_id_OR_org_name").build();
++-----+
+
+  To connect via JWT token as a GitHub App:
+
++-----+
+GitHub github = new GitHubBuilder().withJwtToken("my_jwt_token").build();
++-----+
+
+  To connect via GitHub App installation token on behalf of a user or organization:
+
++-----+
+GitHub github = new GitHubBuilder().withAppInstallationToken("my_installation_token").build();
++-----+
+
+* Property file
+
+  This library defines a common convention so that applications using this library will look at a consistent location.
+  In this convention, the library looks at <<<~/.github>>> property file. The content of the files depends on the way
+  you want this library to authenticate as shown below:
+
+
+  To connect via Username and Password (not recommended):
+
++-----+
+login=kohsuke
+password=012345678
++-----+
+
+  To connect via Personal access token:
+
++-----+
+oauth=4d98173f7c075527cb64878561d1fe70
++-----+
+
+  To connect via Personal access token as a user or organization:
+
++-----+
+login=my_org
+oauth=4d98173f7c075527cb64878561d1fe70
++-----+
+
+  To connect via JWT token as a GitHub App:
+
++-----+
+jwt=my_jwt_token
++-----+
+
+  Once your <<<~/.github>>> property file is properly configured, you can obtain a <<<GitHub>>> instance using:
+
++-----+
+// if you are using the default configuration file
+GitHub github = new GitHubBuilder().fromPropertyFile().build();
+
+// if you need to use a separate configuration file
+GitHub github = new GitHubBuilder().fromPropertyFile("location/my_custom_github.properties").build();
++-----+
+
+* Environmental variables
+
+  This library also allows developers to authenticate GitHub with environmental variables.
+
+  To connect via Username and Password (not recommended):
+
++-----+
+export GITHUB_LOGIN=kohsuke
+export GITHUB_PASSWORD=012345678
++-----+
+
+    To connect via Personal access token:
+
++-----+
+export GITHUB_OAUTH=4d98173f7c075527cb64878561d1fe70
++-----+
+
+    To connect via Personal access token as a user or organization:
+
++-----+
+export GITHUB_LOGIN=my_org
+export GITHUB_OAUTH=4d98173f7c075527cb64878561d1fe70
++-----+
+
+    To connect via JWT token as a GitHub App:
+
++-----+
+export GITHUB_JWT=my_jwt_token
++-----+
+
+    Once exported, you can obtain a <<<GitHub>>> instance using:
+
++-----+
+GitHub github = new GitHubBuilder().fromEnvironment().build();
++-----+
+
+
+Pluggable HTTP client
+
+  This library comes with a pluggable connector to use different HTTP client implementations
+  through <<<HttpConnector>>>. In particular, this means you can use {{{http://square.github.io/okhttp/}OkHttp}},
+  so we can make use of it's HTTP response cache.
+  Making a conditional request against the GitHub API and receiving a 304 response
+  {{{http://developer.github.com/v3/#conditional-requests}does not count against the rate limit}}.
+
+  The following code shows an example of how to set up persistent cache on the disk:
+
++-----+
+Cache cache = new Cache(cacheDirectory, 10 * 1024 * 1024); // 10MB cache
+GitHub gitHub = GitHubBuilder.fromCredentials()
+    .withConnector(new OkHttpConnector(new OkUrlFactory(new OkHttpClient().setCache(cache))))
+    .build();
++-----+