Skip to content

feat: add icon and description to preset #18977

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add icon and description to preset #18977

wants to merge 1 commit into from

Conversation

ssncferreira
Copy link
Contributor

@ssncferreira ssncferreira commented Jul 21, 2025 •
edited
Loading

Description

This PR adds support for description and icon fields to template_version_presets. These fields will allow displaying richer information for presets in the UI, improving the user experience when creating a workspace.
Both fields are optional, non-nullable, and default to empty strings.

Changes

  • Database migration with the addition of description VARCHAR(128) and icon VARCHAR(256) columns to the template_version_presets table.
  • Updated the CreateWorkspacePageView in the UI

UI Changes (Work in progress)

Screenshot 2025-07-24 at 17 02 31 Screenshot 2025-07-24 at 17 02 40

Requires: coder/terraform-provider-coder#422 (release: #19032)
Closes: #18111

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 21, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@ssncferreira ssncferreira force-pushed the ssncferreira/feat-preset-icon-description branch 4 times, most recently from 303e4d1 to 531420f Compare July 24, 2025 15:06
ssncferreira
ssncferreira commented Jul 24, 2025
View reviewed changes
coderd/database/migrations/000351_add_icon_and_description_template_version_presets.up.sql
Comment on lines +2 to +3
ADD COLUMN IF NOT EXISTS description VARCHAR(128) NOT NULL DEFAULT '',
ADD COLUMN IF NOT EXISTS icon VARCHAR(256) NOT NULL DEFAULT '';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applying the same size constraints as:

@ssncferreira ssncferreira force-pushed the ssncferreira/feat-preset-icon-description branch 3 times, most recently from 67bd572 to 9310007 Compare July 24, 2025 15:50
@ssncferreira ssncferreira force-pushed the ssncferreira/feat-preset-icon-description branch from 9310007 to 24493de Compare July 24, 2025 15:56
@ssncferreira ssncferreira marked this pull request as ready for review July 24, 2025 16:03
@ssncferreira ssncferreira requested a review from jaaydenh July 24, 2025 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spikecurtis spikecurtis Awaiting requested review from spikecurtis spikecurtis is a code owner

@johnstcn johnstcn Awaiting requested review from johnstcn johnstcn is a code owner

@jaaydenh jaaydenh Awaiting requested review from jaaydenh

At least 1 approving review is required to merge this pull request.

Assignees

@ssncferreira ssncferreira

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Presets: Support an icon and description in the UI
1 participant
@ssncferreira