forked from googleapis/google-cloud-node
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
2 / 42 of 4 issues completedLabels
documentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsgood first issueGood for newcomersGood for newcomersinvalidThis doesn't seem rightThis doesn't seem right
Description
Reviewer's Guide
Adds initial CI/CD infrastructure: a GitHub Actions workflow to build, push, and deploy a Docker image to GKE using Workload Identity Federation and kustomize, and a minimal CircleCI pipeline to validate CI setup.
Flow diagram for GitHub Actions GKE build-and-deploy workflow
flowchart TD
trigger["Push to branch 'main'"] --> job["Job 'Setup, Build, Publish, and Deploy'"]
job --> checkout["Step: 'Checkout' source code"]
checkout --> auth["Step: 'Authenticate to Google Cloud' using Workload Identity Provider"]
auth --> dockerLogin["Step: 'Docker Auth' to Artifact Registry"]
dockerLogin --> gkeCreds["Step: 'Set up GKE credentials'"]
gkeCreds --> buildPush["Step: 'Build and push Docker container' to Artifact Registry"]
buildPush --> kustomizeSetup["Step: 'Set up Kustomize'"]
kustomizeSetup --> deploy["Step: 'Deploy to GKE' using Kustomize and kubectl"]
deploy --> rollout["Result: Updated Kubernetes Deployment 'gke-test' running new image"]
Flow diagram for CircleCI sample CI pipeline
flowchart TD
trigger["Code push or pipeline trigger on CircleCI"] --> workflow["Workflow 'say-hello-workflow'"]
workflow --> job["Job 'say-hello'"]
job --> dockerExec["Run in Docker image 'cimg/base:current'"]
dockerExec --> checkout["Step: Checkout repository"]
checkout --> sayHello["Step: Run command 'echo Hello, World!'"]
sayHello --> done["Pipeline completes successfully"]
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce a GitHub Actions workflow that builds a Docker image, pushes it to Google Artifact Registry, and deploys it to a GKE cluster on pushes to main. |
|
.github/workflows/google.yml |
| Add a basic CircleCI configuration to validate CI wiring with a sample job and workflow. |
|
.circleci/config.yml |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others. - Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Originally posted by @sourcery-ai[bot] in #215 (comment)
Sub-issues
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsgood first issueGood for newcomersGood for newcomersinvalidThis doesn't seem rightThis doesn't seem right
Projects
Status
Backlog
Status
Todo