Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Gradle installation instructions to README #430

Merged
merged 3 commits into from
Feb 13, 2023
Merged

Add Gradle installation instructions to README #430

merged 3 commits into from
Feb 13, 2023

Conversation

ghokun
Copy link
Member

@ghokun ghokun commented Dec 30, 2022

I have been using error-prone-support in a personal toy project and realized that there is no installation instruction for gradle in website. This PR adds that.

ghokun
ghokun commented Dec 30, 2022
View reviewed changes
README.md Outdated

```groovy
plugins {
// The gradle plugin is an external contribution.
Copy link
Member Author

@ghokun ghokun Dec 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got these lines from this page . Maybe we can rephrase?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Maven section above we link to that page, and then only document the "delta". Perhaps we can directly link to the gradle-errorprone-plugin, and then only document what further changes are necessary?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am working on this, will push a suggestion ~soon.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks better already.

@ghokun ghokun added the documentation A documentation update label Dec 30, 2022
@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@ghokun ghokun requested a review from sandermoelands January 2, 2023 09:41
@ghokun ghokun force-pushed the ghokun/gradle-installation branch from 83499e4 to 9cecf22 Compare January 2, 2023 09:42
@github-actions
Copy link

github-actions bot commented Jan 2, 2023

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie requested review from rickie and Stephan202 January 4, 2023 09:20
@rickie rickie added this to the 0.7.0 milestone Jan 4, 2023
Stephan202
Stephan202 reviewed Jan 4, 2023
View reviewed changes
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick comment; I hope to have a closer look ~this weekend. (I know ~nothing about Gradle, so will need to properly sit down for this.)

README.md Outdated

```groovy
plugins {
// The gradle plugin is an external contribution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Maven section above we link to that page, and then only document the "delta". Perhaps we can directly link to the gradle-errorprone-plugin, and then only document what further changes are necessary?

rickie
rickie reviewed Jan 4, 2023
View reviewed changes
Copy link
Member

@rickie rickie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening a PR @ghokun!

Pushed a suggestion. Also not so known with Gradle so have to take some more time for this.

README.md Outdated
@@ -94,6 +96,33 @@ it:
Prone Support. Alternatively reference this project's `self-check` profile
definition. -->

#### Gradle (Groovy)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can also drop "(Groovy)" 🤔.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. A quick search shows that only configuration part differs.

README.md Outdated

```groovy
plugins {
// The gradle plugin is an external contribution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am working on this, will push a suggestion ~soon.

@github-actions
Copy link

github-actions bot commented Jan 4, 2023

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie modified the milestones: 0.7.0, 0.8.0 Jan 6, 2023
rickie
rickie approved these changes Jan 23, 2023
View reviewed changes
Copy link
Member

@rickie rickie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No changes from my side anymore, it looks good!

@rickie rickie force-pushed the ghokun/gradle-installation branch from d4e1ebb to cab058f Compare January 23, 2023 10:33
@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie modified the milestones: 0.8.0, 0.9.0 Jan 27, 2023
@Stephan202 Stephan202 force-pushed the ghokun/gradle-installation branch from cab058f to c6ea368 Compare February 12, 2023 16:45
Stephan202
Stephan202 approved these changes Feb 12, 2023
View reviewed changes
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebased and added a tiny commit; very clear!

Suggested commit message:

Add Gradle installation instructions to README (#430)

README.md Outdated
// Error Prone Support's Refaster rules.
errorprone("tech.picnic.error-prone-support:refaster-runner:${errorProneSupportVersion}")
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie force-pushed the ghokun/gradle-installation branch from c6ea368 to e673d81 Compare February 13, 2023 10:09
@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie changed the title Add installation instructions for Gradle (groovy) Add Gradle installation instructions to README Feb 13, 2023
@rickie rickie merged commit 0cb03aa into master Feb 13, 2023
@rickie rickie deleted the ghokun/gradle-installation branch February 13, 2023 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rickie rickie rickie approved these changes

@Stephan202 Stephan202 Stephan202 approved these changes

@sandermoelands sandermoelands Awaiting requested review from sandermoelands

Assignees
No one assigned
Labels
documentation A documentation update
Milestone
0.9.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ghokun @Stephan202 @rickie