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.

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

Banjofox/build scripts #303

Merged
merged 14 commits into from
Aug 30, 2023
Merged

Banjofox/build scripts #303

merged 14 commits into from
Aug 30, 2023

Conversation

BanjoFox
Copy link
Collaborator

First draft of installation/build scripts for developer use.

@BanjoFox BanjoFox force-pushed the banjofox/build-scripts branch 4 times, most recently from b76fee0 to bf2abc6 Compare August 22, 2023 15:53
@BanjoFox
Copy link
Collaborator Author

@CodiumAI-Agent /review

@CodiumAI-Agent
Copy link
Contributor

PR Analysis

  • 🎯 Main theme: This PR is focused on creating build scripts for developers and updating the configuration setup in the Rust codebase.
  • 📌 Type of PR: Enhancement
  • Focused PR: Yes, all changes are related to improving the build process and configuration setup.

PR Feedback

  • General suggestions: The PR is well-structured and focused on improving the build process for developers. It would be beneficial to add some tests to ensure the build scripts work as expected across different environments. Also, consider handling potential errors in the build scripts to make them more robust.

  • 🤖 Code feedback:

    • relevant file: src/lib-new.broken.rs
      suggestion: It's recommended to handle unwrapping of Option values in a safer manner. Instead of using unwrap(), consider using unwrap_or(), unwrap_or_else(), or pattern matching to provide a default value or handle the None case appropriately. This can prevent potential panics at runtime. [important]
      relevant line: let config_path = parsed_args.config.unwrap();

    • relevant file: src/lib-new.broken.rs
      suggestion: The configure function seems to be doing a lot of work. Consider breaking it down into smaller, more manageable functions. This will improve readability and maintainability of the code. [medium]
      relevant line: pub fn configure(parsed_args: Args) -> Result {

    • relevant file: dev-setup/debian-setup.sh
      suggestion: The database user password is hardcoded in the script. This could be a potential security risk. Consider prompting the user to enter the password or use environment variables to store sensitive information. [important]
      relevant line:

How to use

Tag me in a comment '@CodiumAI-Agent' and add one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.

@BanjoFox
Copy link
Collaborator Author

@CodiumAI-Agent /improve --extended

Thank you CodiumAI :D

src/lib-new.broken.rs Outdated Show resolved Hide resolved
src/lib-new.broken.rs Outdated Show resolved Hide resolved
dev-setup/debian-setup.sh Outdated Show resolved Hide resolved
dev-setup/macos-setup.sh Outdated Show resolved Hide resolved
doc/AARDWOLF-SETUP.MD Show resolved Hide resolved
doc/TROUBLESHOOTING.md Outdated Show resolved Hide resolved
aardwolf-models/Cargo.toml Show resolved Hide resolved
aardwolf-models/Cargo.toml Show resolved Hide resolved
Copy link
Collaborator

@nicholasguyett nicholasguyett left a comment

Choose a reason for hiding this comment

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

A few relatively minor comments. I noticed that this is adding a lib-new.broken.rs and a lib-old,working.rs. Was this intentional or just artifacts from development?

dev-setup/debian-setup.sh Outdated Show resolved Hide resolved
aardwolf-templates/Cargo.toml Outdated Show resolved Hide resolved
@BanjoFox
Copy link
Collaborator Author

A few relatively minor comments. I noticed that this is adding a lib-new.broken.rs and a lib-old,working.rs. Was this intentional or just artifacts from development?

They are intentional and I have re-built them in a new branch. I needed to revert to the previous /src/lib.rs in order to get the cargo run --bin setup command to work. That is one of the commits that I tried to drop, but got "empty commit" errors.

Copy link
Collaborator

@nicholasguyett nicholasguyett left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you for accommodating my stickler tendencies

@BanjoFox BanjoFox merged commit 75eb08a into main Aug 30, 2023
3 checks passed
@BanjoFox BanjoFox deleted the banjofox/build-scripts branch August 30, 2023 00:35
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.

None yet

3 participants