Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

fix: Put example YAML from the provider in configuration block #388

Merged
merged 3 commits into from
Jun 27, 2022

Conversation

disq
Copy link
Member

@disq disq commented Jun 27, 2022

Contrary to what the comment says, it can't be removed from the code (not a way I could find) because then the comments aren't processed, so they are omitted.

Any string monkey operations should be done on cq-core side (as core needs a valid YAML, otherwise the comments will probably get dropped again) so that's why I avoided them.

This is the best we can do with the \n \n thing, double newlines will abort a comment block and !!null yaml tags can't have them. Indentation is not right but it's close enough:

providers:
    # provider configurations
    - name: aws
      configuration:
      # Optional, Repeated. Add an accounts block for every account you want to assume-role into and fetch data from.
      # accounts:
      #   - id: <UNIQUE ACCOUNT IDENTIFIER>
      # ... snipped ...   
      # max_retries: 10
      # The maximum back off delay between attempts. The backoff delays exponentially with a jitter based on the number of attempts. Defaults to 30 seconds.
      # max_backoff: 30
      #  
      # list of resources to fetch
      resources:
        - accessanalyzer.analyzers
        - acm.certificates
        - apigateway.api_keys
# ... and so on

@disq disq requested a review from a team as a code owner June 27, 2022 10:47
@disq disq requested review from yevgenypats and removed request for a team June 27, 2022 10:47
@disq disq marked this pull request as draft June 27, 2022 10:49
@disq disq marked this pull request as ready for review June 27, 2022 10:56
@disq disq requested a review from bbernays June 27, 2022 10:57
@disq disq merged commit 1e06428 into main Jun 27, 2022
@disq disq deleted the fix/put-example-yaml-in-configuration-block branch June 27, 2022 11:01
kodiakhq bot pushed a commit that referenced this pull request Jun 27, 2022
🤖 I have created a release *beep* *boop*
---


## [0.12.5](v0.12.4...v0.12.5) (2022-06-27)


### Bug Fixes

* Put example YAML from the provider in `configuration` block ([#388](#388)) ([1e06428](1e06428))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants