Docstring fixups
@@ -24,15 +24,19 @@ In addition to fine-grained building blocks, Automation API provides two out of
1. Programs locally available on-disk and addressed via a filepath (local source)::
- stack = create_stack("myOrg/myProj/myStack", work_dir=os.path.join("..", "path", "to", "project"))`
+ ```python
+ stack = create_stack("myOrg/myProj/myStack", work_dir=os.path.join("..", "path", "to", "project"))
+ ```
2. Programs defined as a function alongside your Automation API code (inline source)::
+ ```python
def pulumi_program():
bucket = s3.Bucket("bucket")
pulumi.export("bucket_name", bucket.Bucket)
stack = create_stack("myOrg/myProj/myStack", program=pulumi_program)
+ ```
Each of these creates a stack with access to the full range of Pulumi lifecycle methods
(up/preview/refresh/destroy), as well as methods for managing config, stack, and project settings::
@@ -43,6 +47,7 @@ Each of these creates a stack with access to the full range of Pulumi lifecycle
The Automation API provides a natural way to orchestrate multiple stacks,
feeding the output of one stack as an input to the next as shown in the package-level example below.
The package can be used for a number of use cases:
+
- Driving pulumi deployments within CI/CD workflows
- Integration testing
- Multi-stage deployments such as blue-green deployment patterns
@@ -81,6 +86,7 @@ try:
up_response = stack.up()
except ConcurrentUpdateError:
{ /* retry logic here */ }
+
"""
from .config import (
