feat: add a new optional `GITLAB_COMMENT_CUSTOM_LINKS` env by JounQin · Pull Request #209

feat: add a new optional `GITLAB_COMMENT_CUSTOM_LINKS` env by JounQin · Pull Request #209 · un-ts/changesets-gitlab

Walkthrough

The changes introduce a new optional environment variable, GITLAB_COMMENT_CUSTOM_LINKS. This variable allows users to override the default link in GitLab CLI bot comments. The update is reflected in both documentation and source code. In the code, the logic checks for this variable to determine whether to use a custom link or fall back to a default. Additionally, the relevant type definition has been updated to include this new property.

Changes

Files	Change Summary
.changeset/short-queens-cover.md, README.md	Documented the new optional environment variable `GITLAB_COMMENT_CUSTOM_LINKS` to override the default links in GitLab CLI bot comments.
src/comment.ts, src/types.ts	Modified link construction in CLI bot comments to conditionally use the custom link from `GITLAB_COMMENT_CUSTOM_LINKS`, and updated the `Env` type with a new property.

Sequence Diagram(s)

sequenceDiagram
    participant CLI
    participant CommentBot
    participant Env
    participant GitLab

    CLI->>CommentBot: Request comment generation for merge request
    CommentBot->>Env: Check for GITLAB_COMMENT_CUSTOM_LINKS
    alt Custom Link Available
        Env-->>CommentBot: Return custom link
        CommentBot->>GitLab: Post comment with custom link
    else No Custom Link
        Env-->>CommentBot: Return undefined
        CommentBot->>GitLab: Post comment with default link
    end

Poem

I'm a rabbit, hopping through code with glee,
Found a new link option as spry as can be.
Custom links now in comments, oh what a sight,
Enabling users to choose what feels right.
With whiskers twitching, I celebrate this delight!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/comment.ts

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

src/types.ts

Oops! Something went wrong! :(

ESLint: 9.23.0

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.