add create repo with template support #897

bonnie-young · 2020-07-19T15:12:40Z

Signed-off-by: Yang Ting bonnie.young@maxwit.com

Description

Add two method for GHOrganization class:

createRepositoryWithParametersIsTemplate
createRepositoryWithTemplate

And the corresponding test class

testCreateRepositoryWithParametersIsTemplate
testCreateRepositoryWithTemplate

Before submitting a PR:

We love getting PRs, but we hate asking people for the same basic changes every time.

Push your changes to a branch other than master. Create your PR from that branch.
Add JavaDocs and other comments
Write tests that run and pass in CI. See CONTRIBUTING.md for details on how to capture snapshot data.
Run mvn clean compile locally. This may reformat your code, commit those changes.
Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.

When creating a PR:

Fill in the "Description" above.
Enable "Allow edits from maintainers".

Signed-off-by: Yang Ting <bonnie.young@maxwit.com>

bitwiseman

@bonnie-young
Thanks for the PR. High quality and with tests. Awesome!

Because this is adding new functionality, I need to look at it a bit more. I also don't know enough about repository template API to land this just yet. I'll look at this in the next few days.

bitwiseman

@bonnie-young
This is good but I'll like to see it look a little different. I've added some suggestions as examples but don't treat those as what it has to look like.

If you feel strongly opposed to anything I'm suggesting please say so and we can discuss. I value all view points in the continuing growth and improvement of this project.

Thanks for contributing.

bitwiseman · 2020-07-30T07:59:42Z

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

@@ -20,6 +22,22 @@
        this.builder.with("name", name);
    }

+    GHCreateRepositoryBuilder(GitHub root, String apiUrlTail, String name, Boolean isTemplate) {


@bonnie-young Could you tell me why we need two new constructors?

Could we add an templateRepository(boolean) method to the builder instead?

yes, you are right! sorry for my carelessness.

bitwiseman · 2020-07-30T08:04:08Z

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

+     * @throws IOException
+     *             if repsitory cannot be created
+     */
+    public GHRepository createWithTemplate() throws IOException {


Similar to my previous comment could we have a fromTemplateRepository(String templateOwner, String templateRepo) method? I think the create() method could have .withPreview(BAPTISE) set in general without any negative effect, but I could be wrong.

According to the official doc , I don't think we can add an fromTemplateRepository(String templateOwner, String templateRepo) to the builder, Because templateOwner and templateRepo are parts of the request url not parameters. anyway, I will try it out, and find the result.
"create() method could have .withPreview(BAPTISE) set in general without any negative effect" —— I will try it later also, thanks for your idea.

bitwiseman · 2020-07-30T08:07:52Z

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

+     *            the organization of repository to be created
+     * @return the gh create repository builder
+     */
+    public GHCreateRepositoryBuilder createRepositoryWithTemplate(String templateRepo,


Ah, I see. The create from template repository has almost none of the parameters of general repository creation.
Still I think that limitation is something that could be explained in the javadoc for fromTemplateRepository(String templateOwner, String templateRepo) and include a link to the GitHub docs.

What you've done is good: guiding users to the a non-failure path. However, in this case, I'd rather reduce the surface area and added code in this library.

Also add @Preview and @Deprecated annotations to the methods that call GitHub Preview APIs.

“Also add @Preview and @deprecated annotations to the methods that call GitHub Preview APIs.” —— I see. Thank you for reminding me. But I don't know why need to add the @deprecated annotation.

“Also add @Preview and @deprecated annotations to the methods that call GitHub Preview APIs.” —— I see. Thank you for reminding me. But I don't know why need to add the @deprecated annotation.

I found the answer from oracle official doc:
When to Deprecate
When you design an API, carefully consider whether it supersedes an old API. If it does, and you wish to encourage developers (users of the API) to migrate to the new API, then deprecate the old API. Valid reasons to deprecate an API include:

It is insecure, buggy, or highly inefficient (I got this point)

It is going away in a future release

It encourages bad coding practices

src/test/java/org/kohsuke/github/GHOrganizationTest.java

bitwiseman · 2020-08-04T23:04:57Z

@bonnie-young
Do you think you'll have time to work on this in the next week or two?

bonnie-young · 2020-08-06T03:50:29Z

@bonnie-young
Do you think you'll have time to work on this in the next week or two?

@bitwiseman
I appreciate your reply and careful suggestions a lot. Sorry for the late reply. I asked for leave to go home these days and helped my family deal with some things. Now I get back to work. I will revise PR according to your comments in these two days :)

bitwiseman · 2020-08-06T07:22:50Z

@bonnie-young
Excellent, thanks much. I hope all is well with you and your family.

I plan to publish the next version soon, but we can wait a few days to get this last addition in.

bonnie-young · 2020-08-06T18:40:01Z

@bonnie-young
Excellent, thanks much. I hope all is well with you and your family.

I plan to publish the next version soon, but we can wait a few days to get this last addition in.

@bitwiseman
Thanks a lot！
In these two days, I will finish the modification after work. If I can't finish it in time, please release the next version first, then I'll be done before the next iteration.

Signed-off-by: Yang Ting <bonnie.young@maxwit.com>

bonnie-young and others added 3 commits July 19, 2020 23:07

add create repo with template support

9830927

Signed-off-by: Yang Ting <bonnie.young@maxwit.com>

Merge branch 'master' into add-create-repo-with-template-support

b194a19

Merge branch 'master' into add-create-repo-with-template-support

ac470dd

bitwiseman reviewed Jul 27, 2020

View reviewed changes

bitwiseman requested changes Jul 30, 2020

View reviewed changes

Merge branch 'master' into add-create-repo-with-template-support

bb4d441

bonnie-young force-pushed the add-create-repo-with-template-support branch 3 times, most recently from a2bc5c6 to 5e703be Compare August 10, 2020 03:48

bonnie-young requested a review from bitwiseman August 10, 2020 04:44

bonnie-young force-pushed the add-create-repo-with-template-support branch from a3181a0 to 6afd248 Compare August 12, 2020 13:51

update code for create repository from template

11bc669

Signed-off-by: Yang Ting <bonnie.young@maxwit.com>

bonnie-young force-pushed the add-create-repo-with-template-support branch from 6afd248 to 11bc669 Compare August 12, 2020 14:08

bitwiseman approved these changes Aug 12, 2020

View reviewed changes

bitwiseman merged commit ff4324a into hub4j:master Aug 12, 2020

bitwiseman mentioned this pull request Aug 13, 2020

Added GHRepository.isTemplate() method #923

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add create repo with template support #897

add create repo with template support #897

bonnie-young commented Jul 19, 2020 •

edited

Loading

bitwiseman left a comment •

edited

Loading

bitwiseman left a comment

bitwiseman Jul 30, 2020 •

edited

Loading

bonnie-young Aug 6, 2020

bitwiseman Jul 30, 2020 •

edited

Loading

bonnie-young Aug 6, 2020

bitwiseman Jul 30, 2020 •

edited

Loading

bonnie-young Aug 6, 2020

bonnie-young Aug 9, 2020

bitwiseman commented Aug 4, 2020

bonnie-young commented Aug 6, 2020

bitwiseman commented Aug 6, 2020 •

edited

Loading

bonnie-young commented Aug 6, 2020

add create repo with template support #897

add create repo with template support #897

Conversation

bonnie-young commented Jul 19, 2020 • edited Loading

Description

Before submitting a PR:

When creating a PR:

bitwiseman left a comment • edited Loading

Choose a reason for hiding this comment

bitwiseman left a comment

Choose a reason for hiding this comment

bitwiseman Jul 30, 2020 • edited Loading

Choose a reason for hiding this comment

bonnie-young Aug 6, 2020

Choose a reason for hiding this comment

bitwiseman Jul 30, 2020 • edited Loading

Choose a reason for hiding this comment

bonnie-young Aug 6, 2020

Choose a reason for hiding this comment

bitwiseman Jul 30, 2020 • edited Loading

Choose a reason for hiding this comment

bonnie-young Aug 6, 2020

Choose a reason for hiding this comment

bonnie-young Aug 9, 2020

Choose a reason for hiding this comment

bitwiseman commented Aug 4, 2020

bonnie-young commented Aug 6, 2020

bitwiseman commented Aug 6, 2020 • edited Loading

bonnie-young commented Aug 6, 2020

bonnie-young commented Jul 19, 2020 •

edited

Loading

bitwiseman left a comment •

edited

Loading

bitwiseman Jul 30, 2020 •

edited

Loading

bitwiseman Jul 30, 2020 •

edited

Loading

bitwiseman Jul 30, 2020 •

edited

Loading

bitwiseman commented Aug 6, 2020 •

edited

Loading