Skip to content

Ingestion pipeline imports#491

Open
dwnoble wants to merge 2 commits intodatacommonsorg:masterfrom
dwnoble:reamde-update
Open

Ingestion pipeline imports#491
dwnoble wants to merge 2 commits intodatacommonsorg:masterfrom
dwnoble:reamde-update

Conversation

@dwnoble
Copy link
Contributor

@dwnoble dwnoble commented Mar 24, 2026

Updated the documentation for running the ingestion pipeline, with minor clarifications to the setup steps and corrections to command line arguments for local and dataflow runs

@dwnoble dwnoble requested a review from vish-cs March 24, 2026 00:33
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the usability of the ingestion pipeline by refining its documentation. It ensures that users can correctly set up and execute the pipeline by providing clearer initial setup instructions and rectifying a key command-line parameter, thereby streamlining the process for both local and cloud-based deployments.

Highlights

  • Documentation Clarity: Clarified the setup steps for running the ingestion pipeline, including a new dependency installation step and directory change instruction.
  • Command-Line Arguments: Corrected the --project argument to --projectId in both local and Dataflow execution commands for consistency and correctness.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation for the ingestion pipeline, clarifying setup steps and correcting a command-line argument. While the correction of the --project argument to --projectId is accurate and the added setup steps are helpful, I've identified an issue with the new instructions for running the pipeline locally. The suggested mvn command is incompatible with the directory from which it's supposed to be run, which will likely cause it to fail.

mvn clean install
```

To run the pipeline locally using the Direct runner, cd to the `pipeline/ingestion` directory and run:
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

While adding the instruction to cd into the pipeline/ingestion directory is a good clarification, the mvn command that follows will likely fail when executed from this location. The -pl ingestion -am flags are intended for use when running Maven from a parent directory of the ingestion module, not from within the module directory itself. To fix this, you should either remove the -pl ingestion -am flags from the command or, alternatively, instruct the user to run the command from the project root and adjust the path in the -pl flag (e.g., -pl pipeline/ingestion).

Copy link
Contributor

@vish-cs vish-cs left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants