Add support for universes, update deps, switch to auto-doc (#365)

Author: sethvargo

README.md

@@ -185,145 +185,142 @@ If `parent` is set to `false`, it wil be uploaded to `gs://bucket-name/folder2/f
 
 ## Inputs
 
--   `path` - (Required) The path to a file or folder inside the action's
-    filesystem that should be uploaded to the bucket.
+<!-- BEGIN_AUTOGEN_INPUTS -->
+
+-   <a name="project_id"></a><a href="#user-content-project_id"><code>project_id</code></a>: _(Optional)_ Google Cloud project ID to use for billing and API requests. If not
+    provided, the project will be inferred from the environment, best-effort.
+    To explicitly set the value:
+
+    ```yaml
+    project_id: 'my-project'
+    ```
+
+-   <a name="universe"></a><a href="#user-content-universe"><code>universe</code></a>: _(Optional, default: `googleapis.com`)_ The Google Cloud universe to use for constructing API endpoints. Trusted
+    Partner Cloud and Google Distributed Hosted Cloud should set this to their
+    universe address.
+
+    You can also override individual API endpoints by setting the environment
+    variable `GHA_ENDPOINT_OVERRIDE_<endpoint>` where `<endpoint>` is the API
+    endpoint to override. For example:
+
+    ```yaml
+    env:
+      GHA_ENDPOINT_OVERRIDE_oauth2: 'https://oauth2.myapi.endpoint/v1'
+    ```
+
+    For more information about universes, see the Google Cloud documentation.
+
+-   <a name="path"></a><a href="#user-content-path"><code>path</code></a>: _(Required)_ The path to a file or folder inside the action's filesystem that should be
+    uploaded to the bucket.
 
     You can specify either the absolute path or the relative path from the
     action:
 
     ```yaml
-    path: /path/to/file
+    path: '/path/to/file'
     ```
 
     ```yaml
-    path: ../path/to/file
+    path: '../path/to/file'
     ```
 
--   `destination` - (Required) The destination for the file/folder in the form
-    bucket-name or with an optional prefix in the form bucket-name/prefix
+-   <a name="destination"></a><a href="#user-content-destination"><code>destination</code></a>: _(Required)_ The destination for the file/folder in the form bucket-name or with an
+    optional prefix in the form `bucket-name/prefix`. For example, to upload a
+    file named `file` to the GCS bucket `bucket-name`:
 
     ```yaml
-    destination: bucket-name
+    destination: 'bucket-name'
     ```
 
-    In the above example, the file will be uploaded to gs://bucket-name/file
+    To upload to a subfolder:
 
     ```yaml
-    destination: bucket-name/prefix
+    destination: 'bucket-name/prefix'
     ```
 
-    In the above example, the file will be uploaded to
-    gs://bucket-name/prefix/file
-
--   `gzip` - (Optional) Upload file(s) with gzip content encoding, defaults to
-    true.
+-   <a name="gzip"></a><a href="#user-content-gzip"><code>gzip</code></a>: _(Optional, default: `true`)_ Upload file(s) with gzip content encoding. To disable gzip
+    content-encoding, set the value to false:
 
     ```yaml
     gzip: false
     ```
 
-    In the above example, the file(s) will be uploaded without `gzip`
-    content-encoding
-
--   `resumable` - (Optional) Enable resumable uploads, defaults to true.
+-   <a name="resumable"></a><a href="#user-content-resumable"><code>resumable</code></a>: _(Optional, default: `true`)_ Enable resumable uploads. To disable resumable uploads, set the value to
+    false:
 
     ```yaml
     resumable: false
     ```
 
--   `predefinedAcl` - (Optional) Apply a predefined set of access controls to
-    the file(s).
+-   <a name="predefinedAcl"></a><a href="#user-content-predefinedAcl"><code>predefinedAcl</code></a>: _(Optional)_ Apply a predefined set of access controls to the files being uploaded. For
+    example, to grant project team members access to the uploaded files
+    according to their roles:
 
     ```yaml
-    predefinedAcl: projectPrivate
+    predefinedAcl: 'projectPrivate'
     ```
 
-    In the above example, project team members get access to the uploaded
-    file(s) according to their roles.
-
     Acceptable values are: `authenticatedRead`, `bucketOwnerFullControl`,
     `bucketOwnerRead`, `private`, `projectPrivate`, `publicRead`. See [the
     document](https://googleapis.dev/nodejs/storage/latest/global.html#UploadOptions)
     for details.
 
--   `headers` - (Optional) Set object metadata.
+-   <a name="headers"></a><a href="#user-content-headers"><code>headers</code></a>: _(Optional)_ Set object metadata. For example, to set the `Content-Type` header to
+    `application/json` and custom metadata with key `custom-field` and value
+    `custom-value`:
 
     ```yaml
     headers: |-
-      content-type: application/json
-      x-goog-meta-custom-field: custom-value
+      content-type: 'application/json'
+      x-goog-meta-custom-field: 'custom-value'
     ```
 
-    In the above example, file `Content-Type` will be set to `application/json`
-    and custom metadata with key `custom-field` and value `custom-value` will be
-    added to it.
-
     Settable fields are: `cache-control`, `content-disposition`,
     `content-encoding`, `content-language`, `content-type`, `custom-time`. See
     [the
     document](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata#settable-fields;-field-values)
-    for details.
-
-    All custom metadata fields must be prefixed with `x-goog-meta-`.
+    for details. All custom metadata fields must be prefixed with
+    `x-goog-meta-`.
 
--   `parent` - (Optional) Whether parent dir should be included in GCS
-    destination, defaults to true.
+-   <a name="parent"></a><a href="#user-content-parent"><code>parent</code></a>: _(Optional, default: `true`)_ Whether the parent directory should be included in GCS destination path. To disable this:
 
     ```yaml
     parent: false
     ```
 
--   `glob` - (Optional) Glob pattern.
+-   <a name="glob"></a><a href="#user-content-glob"><code>glob</code></a>: _(Optional)_ Glob pattern to match for files to upload.
 
     ```yaml
     glob: '*.txt'
     ```
 
--   `concurrency` - (Optional) Number of files to simultaneously upload,
-    defaults to 100.
+-   <a name="concurrency"></a><a href="#user-content-concurrency"><code>concurrency</code></a>: _(Optional, default: `100`)_ Number of files to simultaneously upload.
 
     ```yaml
-    concurrency: 10
+    concurrency: '10'
     ```
 
--   `process_gcloudignore` - (Optional) Process a `.gcloudignore` file present
-    in the top-level of the repository. If true, the file is parsed and any
-    filepaths that match are not uploaded to the storage bucket. Defaults to
-    true.
+-   <a name="process_gcloudignore"></a><a href="#user-content-process_gcloudignore"><code>process_gcloudignore</code></a>: _(Optional, default: `true`)_ Process a `.gcloudignore` file present in the top-level of the repository.
+    If true, the file is parsed and any filepaths that match are not uploaded
+    to the storage bucket. To disable, set the value to false:
 
     ```yaml
-    process_gcloudignore: true
+    process_gcloudignore: false
     ```
 
--   `project_id` - (Optional) Google Cloud project ID to use for billing and API
-    requests. By default, this is extracted from the running environment.
 
-    ```yaml
-    project_id: 'my-project'
-    ```
+<!-- END_AUTOGEN_INPUTS -->
+
 
 ## Outputs
 
-List of successfully uploaded file(s).
+<!-- BEGIN_AUTOGEN_OUTPUTS -->
 
-For example:
+-   `uploaded`: Comma-separated list of files that were uploaded.
 
-```yaml
-- id: 'upload-file'
-  uses: 'google-github-actions/upload-cloud-storage@v2'
-  with:
-    path: '/path/to/file'
-    destination: 'bucket-name/file'
-```
 
-will be available in future steps as the output "uploaded":
+<!-- END_AUTOGEN_OUTPUTS -->
 
-```yaml
-- id: 'publish'
-  uses: 'foo/bar@v1'
-  env:
-    file: '${{ steps.upload-file.outputs.uploaded }}'
-```
 
 ## Authorization