Use "concise" diff comment in cases "regular" diff comment is > 65536

[Oded-B]

Description

This pull request introduces several improvements to the handling and logging of ArgoCD diff comments, including the addition of a concise template for large comments, and refactoring of error logging. The most important changes include defining a constant for the maximum GitHub comment size, adding logic to handle large diff comments, and creating a concise template for such comments.

Improvements to handling large diff comments:

• internal/pkg/githubapi/github.go: Defined a new constant githubCommentMaxSize to specify the maximum size of GitHub comments.
• internal/pkg/githubapi/github.go: Added logic to check the size of the generated diff comment and switch to a concise template if the comment is too large.

Enhancements to logging:

• internal/pkg/githubapi/github.go: Refactored error logging to use ghPrClientDetails.PrLogger instead of the global log object for more consistent and contextual logging.

New concise template:

• templates/argoCD-diff-pr-comment-concise.gotmpl: Created a new concise template for ArgoCD diff comments that are too large to fit within the GitHub comment size limit.
  Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.

Example of concise image:

Type of Change

• Bug Fix
• New Feature
• Breaking Change
• Refactor
• Documentation
• Other (please describe)

Checklist

• I have read the contributing guidelines
• Existing issues have been referenced (where applicable)
• I have verified this change is not present in other open pull requests
• Functionality is documented
• All code style checks pass
• New code contribution is covered by automated tests
• All new and existing tests pass