Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

sg: Add description field to sg commands#39240

Merged
marekweb merged 10 commits into
mainfrom
sg-command-descriptions
Jul 26, 2022
Merged

sg: Add description field to sg commands#39240
marekweb merged 10 commits into
mainfrom
sg-command-descriptions

Conversation

@marekweb

Copy link
Copy Markdown
Contributor

Add a description field to sg commands specified in sg.config.yaml

The description is displayed in the list of commands when running sg run

Test plan

  • Run sg run
  • See that the command list now shows a description, when provided in sg.config.yaml

@cla-bot cla-bot Bot added the cla-signed label Jul 21, 2022
@marekweb marekweb linked an issue Jul 21, 2022 that may be closed by this pull request
@marekweb marekweb changed the title Add description field to sg commands sg: Add description field to sg commands Jul 21, 2022
@marekweb marekweb added sg sg, the Sourcegraph developer command team/devx labels Jul 21, 2022
@marekweb marekweb requested a review from a team July 21, 2022 18:46
@marekweb marekweb marked this pull request as ready for review July 21, 2022 18:54
Comment thread dev/sg/sg_run.go Outdated
Comment thread dev/sg/internal/run/command.go
@sourcegraph-bot

sourcegraph-bot commented Jul 21, 2022

Copy link
Copy Markdown
Contributor

Codenotify: Notifying subscribers in OWNERS files for diff d70a53b...5b960c9.

Notify File(s)
@mrnugget dev/sg/internal/run/command.go
dev/sg/sg_run.go
@sourcegraph/dev-experience dev/sg/internal/run/command.go
dev/sg/sg_run.go

Comment thread sg.config.yaml Outdated
Marek and others added 5 commits July 21, 2022 18:43
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
Co-authored-by: Robert Lin <robert@bobheadxi.dev>

@jhchabran jhchabran left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice idea, I think this will help discoverability!

* repo-updater
* searcher
* server
* server: Run an all-in-one sourcegraph/server image

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is a great idea! While it's kind of common knowledge that the server refers to the all in one instance, the description adds value in there.

* otel-collector: OpenTelemetry collector
* postgres_exporter
* prometheus
* redis-postgres

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Dockerized version of redis and postgres

* symbols
* syntax-highlighter
* web
* web-standalone-http

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This and the following one would benefit from having a description too!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah all the web stuff could do with some descriptions, cc @sourcegraph/frontend-platform-devs - but I don't think it needs to be in this PR :)

@marekweb marekweb merged commit c664999 into main Jul 26, 2022
@marekweb marekweb deleted the sg-command-descriptions branch July 26, 2022 14:51
efritz pushed a commit that referenced this pull request Jul 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed sg sg, the Sourcegraph developer command

Projects

None yet

Development

Successfully merging this pull request may close these issues.

dev/sg: commands and commandset descriptions

4 participants