Skip to content

Commit

Permalink
fix(docs): Update README to include implemented update command (#492)
Browse files Browse the repository at this point in the history
The README points to #20
and says `Update` isn't implemented.

[Diff](#433) and
[Read](#432) are still
not done, but [Update is
implemented](https://github.com/pulumi/pulumi-command/blob/e7e39fd913708c3e5255d8399c87a736553fec43/sdk/python/pulumi_command/remote/command.py#L196)

The example code could be updated (hah!) to include an `update` (maybe
with Luke's `color`/`description` example), but this PR just removes
information that misled me.
  • Loading branch information
stooj authored Jul 15, 2024
1 parent e7e39fd commit 8928e7f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ export const output = rand.stdout;

### Using `local.Command `with CURL to manage external REST API

This example uses `local.Command` to create a simple resource provider for managing GitHub labels, by invoking `curl` commands on `create` and `delete` commands against the GitHub REST API. A similar approach could be applied to build other simple providers against any REST API directly from within Pulumi programs in any language. This approach is somewhat limited by the fact that `local.Command` does not yet support `diff`/`update`/`read`. Support for those may be [added in the future](https://github.com/pulumi/pulumi-command/issues/20).
This example uses `local.Command` to create a simple resource provider for managing GitHub labels, by invoking `curl` commands on `create` and `delete` commands against the GitHub REST API. A similar approach could be applied to build other simple providers against any REST API directly from within Pulumi programs in any language. This approach is somewhat limited by the fact that `local.Command` does not yet support `diff`/`read`. Support for [Read](https://github.com/pulumi/pulumi-command/issues/432) and [Diff](https://github.com/pulumi/pulumi-command/issues/433) may be added in the future.

This example also shows how `local.Command` can be used as an implementation detail inside a nicer abstraction, like the `GitHubLabel` component defined below.

Expand Down

0 comments on commit 8928e7f

Please sign in to comment.