Skip to content

Commit

Permalink
docs(samples): add readme (#849)
Browse files Browse the repository at this point in the history
* docs(samples): add readme

* address reviewer comments
  • Loading branch information
anguillanneuf committed Sep 20, 2021
1 parent 81b4511 commit 66135cf
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions samples/README.md
@@ -0,0 +1,25 @@
# How to run the samples

1. Clone this repo and navigate to the `snippets` directory.
```shell
git clone https://github.com/googlepis/java-pubsub
cd java-pubsub/samples/snippets
```

1. [Obtain GCP user access credentials] via a web flow for your application.
```shell
gcloud auth application-default login
```

1. With [Maven] installed, run a sample that has the to-do section completed:
```shell
mvn clean compile exec:java -Dexec.mainClass=pubsub.CreateTopicExample
```

1. To run the samples test:
```shell
mvn -Dtest=pubsub.AdminIT test
```

[Maven]: https://maven.apache.org/
[Obtain GCP user access credentials]: https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login

0 comments on commit 66135cf

Please sign in to comment.