output_options renamed upload_options re #128

cirrus-geo · Sep 8, 2022 · 27171ab · 27171ab
1 parent e9fd901
commit 27171ab
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -65,6 +65,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   has no default value and is required. It can be specified multiple times in the case
   of a task that uses both batch and lambda. ([#123])
 
+### ⚠️ Deprecations
+
+- `ProcessPayload.process['output_options']` has been renamed to `'upload_options'` ([#128])`
+
 ### Added
 
 - experimental support for lambdas using container images ([#139])
@@ -463,6 +467,7 @@ Initial release
 [#114]: https://github.com/cirrus-geo/cirrus-geo/issues/114
 [#116]: https://github.com/cirrus-geo/cirrus-geo/issues/116
 [#123]: https://github.com/cirrus-geo/cirrus-geo/issues/123
+[#128]: https://github.com/cirrus-geo/cirrus-geo/issues/128
 [#131]: https://github.com/cirrus-geo/cirrus-geo/issues/131
 [#132]: https://github.com/cirrus-geo/cirrus-geo/issues/132
 [#135]: https://github.com/cirrus-geo/cirrus-geo/issues/135

diff --git a/src/cirrus/builtins/tasks/publish/README.md b/src/cirrus/builtins/tasks/publish/README.md
@@ -11,9 +11,9 @@ Configuration parameters are passed in `payload['process']['tasks']['publish']`:
 | public    | bool     | Set ACL of STAC Item on s3 to `public-read` (Default: False) |
 | sns       | [string] | Additional SNS topic ARNs to publish to (Default: [])  |
 
-### Output Options
+### Upload Options
 
-The `publish` task also uses the following parameters supplied in `payload['process']['output_options']`:
+The `publish` task also uses the following parameters supplied in `payload['process']['upload_options']`:
 
 | Field         | Type     | Description |
 | ------------- | -------- | ----------- |

diff --git a/src/cirrus/builtins/workflows/publish-only/test-payload.json b/src/cirrus/builtins/workflows/publish-only/test-payload.json
@@ -422,7 +422,7 @@
     "process": {
         "workflow": "publish-only",
         "replace": true,
-        "output_options": {
+        "upload_options": {
             "path_template": "${collection}/${year}/${month}/${id}",
             "collections": {
                 "test-collection": ".*"
@@ -433,4 +433,4 @@
             }
         }
     }
-}
+}
diff --git a/src/cirrus/docs/30_payload.rst b/src/cirrus/docs/30_payload.rst
@@ -129,7 +129,7 @@ Process Definition
    * - input_collections
      - string
      - An identifier representing the set of collections the input items belong to
-   * - output_options
+   * - upload_options
      - :ref:`payload-outputopts`
      - Parameters affecting the upload of item assets
    * - tasks
@@ -245,7 +245,7 @@ will be published. The first matching collection will be used.
 
 .. code-block:: json
 
-    "output_options": {
+    "upload_options": {
         "collections": {
             "sat-a-l1": "sa.*"
             "sat-b-l1": "sb.*"

diff --git a/src/cirrus/docs/50_operation.rst b/src/cirrus/docs/50_operation.rst
@@ -7,7 +7,7 @@ Process definition
 Workflow
 ^^^^^^^^
 
-output_options
+upload_options
 ^^^^^^^^^^^^^^
 
 Output collections

diff --git a/tests/fixtures/build/hashes.json b/tests/fixtures/build/hashes.json
@@ -36,7 +36,7 @@
         "size": 79
     },
     "lambdas/publish/README.md": {
-        "shasum": "df46c55ffe39c090c2790c4e47ff8bd6bea814c796cf4f6479e97afa25b4f0e7",
+        "shasum": "1f36411f2362f799081703a8f4f87adff1ceab0cfba232f985f1c17d24768e9a",
         "size": 826
     },
     "lambdas/publish/lambda_function.py": {