Enhance Logging for Code Repository Interactions in ZenML

[strickvl]

Open Source Contributors Welcomed!

Please comment below if you would like to work on this issue!

Contact Details [Optional]

support@zenml.io

What happened?

Users currently do not receive sufficient feedback from ZenML regarding the status and actions taken when interacting with code repositories. Specifically, there is a lack of clear log messages in scenarios where the pipeline code in a repository is dirty/has unpushed changes, or when previously built Docker images cannot be reused due to certain repository conditions.

Task Description

Improve the logging mechanism in ZenML to provide additional and clearer log messages that explain the reasoning behind certain actions or inactions when using code repositories. This includes informing users about the need to commit and push changes for reusing previously built Docker images, and explaining why builds are or are not being reused.

Expected Outcome

• Users should receive explicit log messages indicating if their code repository is in a state that prevents the reuse of Docker images (e.g., dirty repository or unpushed changes).
• If a build cannot be reused despite the repository being clean and up-to-date, users should be informed about this and provided with possible reasons or actions.
• These log enhancements will improve user understanding and streamline the development process in ZenML.

Steps to Implement

• Identify key points in the code repository interaction process where additional logging would be beneficial.
• Implement log messages that clearly explain the status of the code repository and its impact on Docker image reuse.
• Ensure these messages are informative, guiding users on necessary actions (like committing and pushing changes).
• Test these log messages in various scenarios to ensure they are triggered appropriately and provide useful information.
• Update any relevant documentation to include information about these new log messages and their implications.

Additional Context

Effective communication and feedback when interacting with code repositories are crucial for a seamless user experience in ZenML, especially for users managing complex pipelines with dependencies on repository states.

Code of Conduct

• I agree to follow this project's Code of Conduct

[og118]

Hi, this issue seems interesting, and I would like to contribute. Although the link to code repositories seems broken (this one). Also could you share some additional docs to get started with the work?

[htahir1]

@og118 Thanks for helping out! Currently , the docs arent the best ones, so please feel free to ask here in this issue as you progress. But the two relevant sections are:

https://docs.zenml.io/user-guide/production-guide/connect-code-repository

https://docs.zenml.io/user-guide/advanced-guide/configuring-zenml/connect-your-git-repository

[AryaMoghaddam]

Hello I ca either take up this issue or issue number #2253, both are unassigned

[htahir1]

@AryaMoghaddam more than welcome!