github / maven-plugins

Official GitHub Maven Plugins
MIT License
584 stars 198 forks source link

Needs documentation specifically relating to publishing to an organization project #84

Open ctubbsii opened 9 years ago

ctubbsii commented 9 years ago

The documentation leaves everything quite unclear when it comes to managing a project in an organizational account. Who is the repository owner? The org-name, or the individual user-name? What URL could I put that "just works", or do I always need to specify the individual properties explicitly in this case?

What if you're using an OAuth token (which, as far as I can tell, can only be generated for individuals, not orgs)? Which OAuth permissions are needed to grant the plugin the ability to publish the site to an organizational repo using the individual user's OAuth credentials?

Any help and/or improved documentation on this would be very helpful. I still cannot get it to work.

ctubbsii commented 9 years ago

More information:

I finally got things working, using my individual OAuth token, which required granting "public_repo" and "user:email" to work.

I did not specify the repositoryOwner and repositoryName explicitly. I let it infer that. In my project, I have the github.io address for my URL:

<url>http://revelc.github.io/apilyzer-maven-plugin</url>

In my scm section, I have:

<scm>
  <connection>scm:git:https://github.com/revelc/apilyzer-maven-plugin.git</connection>
  <developerConnection>scm:git:git@github.com:revelc/apilyzer-maven-plugin.git</developerConnection>
  <url>https://github.com/revelc/apilyzer-maven-plugin</url>
</scm>

I'm guessing it is inferring the correct repository from one of those.