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

docs(samples): add readme #849

Merged
merged 2 commits into from Sep 20, 2021
Merged

docs(samples): add readme #849

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d6353f
docs(samples): add readme
anguillanneuf Sep 20, 2021
4cc28e3
address reviewer comments
anguillanneuf Sep 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions samples/README.md
View file
Open in desktop
@@ -0,0 +1,20 @@
# 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. With [Maven] installed and the environment variable `GOOGLE_APPLICATION_CREDENTIALS` set to point to your [GCP service account] key file, run a sample that has the to-do section completed:
Copy link

Choose a reason for hiding this comment

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

Is this still the right thing to ask? We don't really want them downloading SA's any more.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call. Updated.

```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/
[GCP Service account]: https://cloud.google.com/iam/docs/service-accounts