Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/veggiemonk/cloud-run-jobs-demo
Cloud Run Jobs demo to fetch your GitHub starred repositories
https://github.com/veggiemonk/cloud-run-jobs-demo
batch cloud-build cloud-run cloud-run-jobs cloud-workflows demo gcloud gcp github-stars golang google-cloud slides
Last synced: 20 days ago
JSON representation
Cloud Run Jobs demo to fetch your GitHub starred repositories
- Host: GitHub
- URL: https://github.com/veggiemonk/cloud-run-jobs-demo
- Owner: veggiemonk
- Created: 2022-12-03T23:09:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T20:44:03.000Z (about 1 year ago)
- Last Synced: 2024-10-13T03:53:57.212Z (about 1 month ago)
- Topics: batch, cloud-build, cloud-run, cloud-run-jobs, cloud-workflows, demo, gcloud, gcp, github-stars, golang, google-cloud, slides
- Language: Go
- Homepage:
- Size: 5.61 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloud Run Jobs Demo
## Downloading Starred Repositories
This project is a demonstration of how to use Google Cloud Run Jobs to periodically download
and update a user's starred repositories from the GitHub API.
It includes a sample Cloud Run Job that uses the GitHub API to fetch the list of
repositories starred by a specified user and log them in order to route those logs to a sink such as BigQuery.
## Prerequisites
To run the demo, you will need:
* A Google Cloud account with access to the Google Cloud Run, Cloud Workflow, and Cloud Scheduler services.
* The Google Cloud SDK, which includes the gcloud command-line tool for managing Google Cloud resources.
* A GitHub personal access token with the public_repo scope, which will be used to authenticate the GitHub API requests.
## Running the demo
To run the demo, follow these steps:
Clone or download the [Cloud Run Jobs Demo](https://github.com/veggiemonk/cloud-run-jobs-demo) repository to your local machine.
Open a terminal and navigate to the root directory of the project.
```bash
git clone https://github.com/veggiemonk/cloud-run-jobs-demo
cd cloud-run-jobs-demo
```
### Locally
Set the environment variable `GITHUB_TOKEN` to your GitHub personal access token:
```bash
./build.sh
export GITHUB_TOKEN=
./bin/batch --username --github-token $GITHUB_TOKEN
```
### In Cloud Run
Use the gcloud tool to authenticate and set your default project and region:
```bash
gcloud auth login
gcloud config set project
gcloud config set run/region
```
> Read the `setup.sh` script to understand what is needed to run the demo.
```bash
cat setup.sh
```
Here is a sample of what will be deployed:
## Start presentation
```bash
go get golang.org/x/tools/cmd/present # install present binary in your $GOPATH
make presentation
```
## Resources
* [3 ways to embed a commit hash in Go programs](https://developers.redhat.com/articles/2022/11/14/3-ways-embed-commit-hash-go-programs#)
* [Learning Go by examples Series](https://dev.to/aurelievache/series/13751) by [Aurélie Vache](https://dev.to/aurelievache)
* [The best Go framework](https://threedots.tech/post/best-go-framework/)
* [Go structured logging proposal](https://go.googlesource.com/proposal/+/master/design/56345-structured-logging.md)
* [Run bash script in Cloud Build](https://cloud.google.com/build/docs/configuring-builds/run-bash-scripts)
* [Cloud Run container contract](https://cloud.google.com/run/docs/container-contract#env-vars)
* [LibHunt Go](https://www.libhunt.com/l/go)
* [OSS Insight](https://ossinsight.io/)
## Interesting projects
* [Golang GCP Samples](https://github.com/GoogleCloudPlatform/golang-samples/)
* [twitter-audit-log](https://github.com/ahmetb/twitter-audit-log)
* [Ardanlabs Service](https://github.com/ardanlabs/service)
* [Ardanlabs Conf](https://pkg.go.dev/github.com/ardanlabs/conf/v3#section-documentation)
* [ASCII text art generator](https://textkool.com/en/ascii-art-generator)
* [Crontab guru](https://crontab.guru/)
* [Excalidraw](https://excalidraw.com/)