turbot / flowpipe

Flowpipe is a cloud scripting engine. Automation and workflow to connect your clouds to the people, systems and data that matters.
https://flowpipe.io
GNU Affero General Public License v3.0
383 stars 16 forks source link

Add support for `documentation` argument in pipeline. #384

Closed vkumbha closed 11 months ago

vkumbha commented 11 months ago

As per the docs, pipeline supports documentation argument. But I get an error.

Argument Type Optional? Description
documentation String (Markdown) Optional A markdown string containing a long form description, used as documentation for the mod on hub.steampipe.io.

Error:

$ flowpipe pipeline list
Error: Failed to decode mod:
Unable to parse documentation attribute
(/Users/venu/turbie/turbot/_docs_qa/learn_flowpipe/learn.fp:4,3-42)

Here is my pipeline:

pipeline "get_astronauts" {
  title       = "Get Astronauts"
  description = "Get astronauts in space right now."
  documentation = file("./docs/index.md")

  param "url" {
    type    = string
    default = "http://api.open-notify.org/astros"
  }

  step "http" "whos_in_space" {
    url    = param.url
    method = "get"
  }

  output "people_in_space" {
    description = "List of people in space right now."
    value       = step.http.whos_in_space.response_body.people[*].name
    sensitive   = true
  }
}
cbruno10 commented 11 months ago

Duplicate of https://github.com/turbot/pipe-fittings/issues/77, @vkumbha are you still seeing this with the latest version though?

vhadianto commented 11 months ago

Yes I'm fairly sure this has been fixed with the latest version. It's the same issue with https://github.com/turbot/pipe-fittings/issues/77

vkumbha commented 11 months ago

@vhadianto @cbruno10 Thanks for pointing it out. I can confirm it is fixed in the latest version v0.1.0-beta.202312041337. Closing the ticket. Thank you!