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

Miscellaneous documentation update #111

Merged
merged 4 commits into from
Feb 13, 2020
Merged

Miscellaneous documentation update #111

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5013d18
Downgrade gradle version to preserve support to Gradle 5+ and update …
macisamuele Feb 12, 2020
af3cca6
Ensure that aactivator uses gradle setup to install pre-commit hooks
macisamuele Feb 12, 2020
7f68256
Update README to refer to gradlew commands instead of make
macisamuele Feb 12, 2020
cd96790
Update CHANGES.md
macisamuele Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .activate.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
make install-hooks
./gradlew installVenv installHooks

source venv/bin/activate
2 changes: 2 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Here you can find the release notes for this project. Please note that list of r
* ⚙️ Gradle to 5.6.2 [#67]
* ⚙️ Add JaCoCo for CodeCov [#66]

⚠️: `swagger-gradle-codegen:plugin:1.3.0` is **NOT** supported on Gradle 5
macisamuele marked this conversation as resolved.
Show resolved Hide resolved

Thanks to @cortinico @doug-precocity @redwarp @macisamuele @filipemp for the support with this release

## v1.2.0 (2019-07-31)
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,15 @@ We also recommend you set up:
Before starting developing, please run:

```
make install-hooks
./gradlew installHooks
```

This will take care of installing the pre-commit hooks to keep a consistent style in the codebase.

While developing, you can run tests on the plugin using:
While developing, you can build, run pre-commits, checks & tests on the plugin using:

```
./gradlew plugin:test
./gradlew preMerge
```

Make sure your tests are all green ✅ locally before submitting PRs.
Expand Down
4 changes: 3 additions & 1 deletion gradle/wrapper/gradle-wrapper.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.1-all.zip
# Remember to update the README.md file once the version is updated
# Prevent https://github.com/Yelp/swagger-gradle-codegen/issues/108 to happen again
distributionUrl=https\://services.gradle.org/distributions/gradle-5.5-all.zip
macisamuele marked this conversation as resolved.
Show resolved Hide resolved
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists