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

Document dynamic changesetTemplates and steps.outputs #17286

Merged
merged 5 commits into from
Jan 19, 2021

Conversation

mrnugget
Copy link
Contributor

@mrnugget mrnugget commented Jan 14, 2021

This pull request does multiple things:

  • documents steps.outputs in campaign spec reference with lots of examples to show how they work
  • documents which changesetTemplate fields now allow templating in campaign spec reference
  • documents which template variables are available in outputs in campaign spec templating doc
  • documents which template variables are available in changesetTemplate in campaign spec templating doc
  • change links to Sourcegraph CLI from linking to the github repository to the CLI docs, now that we have them
  • switch to using tables to document the available variables in templating fields. That looks like this:

image

I also decided to do the following:

  • remove the Experimental badge next to "Campaign spec templating"
  • change the Experimental badge next to fields in campaign spec YAML reference to a Templating badge that links to the templating page. That looks like this:

screenshot_2021-01-18_12 59 38@2x

Why remove the Experimental badge? I think templating is here to stay and features (such as dynamic changeset templates) build on top of it. Having the experimental badge might scare users off, which is bad, since a lot of cool things (e.g.: only run commands over matched files) are possible with templating. And while we will surely update it and/or might make drastic changes to it in the future, that's not different to any other features we currently have.

@mrnugget mrnugget force-pushed the mrn/doc-dyn-changesettemplates branch from 9e457fa to 4000d42 Compare January 18, 2021 12:01
@mrnugget mrnugget changed the title Document steps.output in campaign spec YAML reference Document dynamic changesetTemplates and steps.outputs Jan 18, 2021
@mrnugget mrnugget added docs batch-changes Issues related to Batch Changes labels Jan 18, 2021
@mrnugget mrnugget marked this pull request as ready for review January 18, 2021 13:39
@mrnugget mrnugget requested review from a team and malomarrec January 18, 2021 13:39
@sourcegraph-bot
Copy link
Contributor

sourcegraph-bot commented Jan 18, 2021

Notifying subscribers in CODENOTIFY files for diff c0c43b7...805b804.

Notify File(s)
@LawnGnome doc/campaigns/index.md
doc/campaigns/references/campaign_spec_templating.md
doc/campaigns/references/campaign_spec_yaml_reference.md
doc/campaigns/references/index.md
@christinaforney doc/_resources/assets/docsite.css
doc/campaigns/index.md
doc/campaigns/references/campaign_spec_templating.md
doc/campaigns/references/campaign_spec_yaml_reference.md
doc/campaigns/references/index.md
@eseliger doc/campaigns/index.md
doc/campaigns/references/campaign_spec_templating.md
doc/campaigns/references/campaign_spec_yaml_reference.md
doc/campaigns/references/index.md

Copy link
Member

@eseliger eseliger left a comment

Choose a reason for hiding this comment

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

Great, thanks for writing these things up. Just two small suggestions I'd personally add :)

doc/campaigns/references/campaign_spec_yaml_reference.md Outdated Show resolved Hide resolved
Co-authored-by: Erik Seliger <erikseliger@me.com>
Copy link
Contributor

@LawnGnome LawnGnome left a comment

Choose a reason for hiding this comment

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

LGTM, and I definitely support removing the experimental flag at this point.

Co-authored-by: Adam Harvey <aharvey@sourcegraph.com>
@mrnugget mrnugget merged commit 749f6de into main Jan 19, 2021
@mrnugget mrnugget deleted the mrn/doc-dyn-changesettemplates branch January 19, 2021 09:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
batch-changes Issues related to Batch Changes docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants