Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Commit

Permalink
chore: Update docs to reference Maven (#429)
Browse files Browse the repository at this point in the history
* chore: Update docs to reference maven

* chore: Update README
  • Loading branch information
lqiu96 committed Dec 9, 2022
1 parent dc41e6f commit 3bcc439
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,23 @@ APIs. It currently contains the following packages:
formatted as Google API resource names.
- resourcenames: Resource Name library used by generated resource name types

> For new and existing Developers/ Contributors:
>
> In December 2022, api-common-java's build tool has been migrated from gradle to maven.
> Gradle related files are no longer being maintained and will be removed.
>
> The artifact coordinates in Maven Central (`{{ group_id }}:{{ artifact_id }}`) remain the same.

Java Versions
-------------

Java 7 or above is required for using this library.
Java 8 or above is required for using this library.

To build this project, JDK 11 or above is required.
The build produces Java bytecode targeted for Java 8.

The project uses Maven to build.

Contributing
------------
Expand Down Expand Up @@ -57,14 +70,14 @@ Build and Test
To build this library, please do the following.

```sh
./gradlew build
mvn clean install
```

After making changes, run the following commands to format your code and test your changes.

```sh
./gradlew googleJavaFormat
./gradlew test
mvn fmt:format
mvn test
```

[CONTRIBUTING]:https://github.com/googleapis/api-common-java/blob/main/CONTRIBUTING.md
Expand Down

0 comments on commit 3bcc439

Please sign in to comment.