Propose a change
clickd_proposeProposes a change before you deploy it, emailing the person Approve and Decline links that lapse in 72 hours.
When: before each deploy to a site clickd_proposals says is set to approve.
Instead: clickd_proposals with the id to wait for the answer; clickd_log_work, naming it, once carried out.
Inputs: site is a domain, like example.com. title is the change in a few words; summary what it does and why; rule the rule id it answers; pages the paths it changes, comma separated; diff a unified diff, shown and never applied.
Returns: proposal ({ id, state, deploy, ... }), note and promise.
Fails: a site not claimed with this key answers not found; 20 proposals a site an hour at most. Needs a person's key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| diff | No | A unified diff, at most 20,000 characters. | |
| rule | No | The rule id it answers, such as answer-first. | |
| site | Yes | The site, as a domain such as example.com. | |
| pages | No | Paths separated by commas, at most 20; none for the whole site. | |
| title | Yes | The change in a few words, at most 120 characters. | |
| summary | Yes | What it does and why, at most 2000 characters. |