Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

publish.github_gist publisher in github plugin #134

Closed
traut opened this issue Mar 25, 2024 · 0 comments · Fixed by #222
Closed

publish.github_gist publisher in github plugin #134

traut opened this issue Mar 25, 2024 · 0 comments · Fixed by #222
Milestone

Comments

@traut
Copy link
Member

traut commented Mar 25, 2024

Description

GitHub Gists is a very easy way to publish Markdown / HTML content on the internet.

Use Case

Publish rendered content (Markdown / HTML) as a public or private GitHub Gist.

Requirements

  • configuration attributes:
    • github_token -- a required string attribute, that contains a valid GitHub Auth token. It will be used in the HTTP header during API calls: Authorization: Bearer $TOKEN (docs)
  • execution attributes:
    • description - (optional) a string attribute, treated as a Go-template string
    • filename - (optional) a string attribute, a key for a file content to be included in the gist. Treated as a Go-template string
      • if not set, the value will be <template-name>.<format-ext>, where <template-name> is the name of the Fabric document template, and <format-ext> is a file extension for a selected content format (md / html)
    • make_public - (optional) a bool attribute, false by default (!)
    • gist_id - (optional) a string attribute. If provided, the existing gist is updated (using gist update endpoint) instead of creating a new gist

Notes:

  • the data sink supports only markdown and HTML output formats
  • after the context is published, the data sink should output an info log message with a link to the gist created / updated

Additional Information

@traut traut added the plugins label Mar 25, 2024
@traut traut added this to the v0.5 milestone Mar 25, 2024
@traut traut added publisher and removed plugins labels Jul 30, 2024
@traut traut changed the title publish.github_gist data sink in github plugin publish.github_gist publisher in github plugin Jul 30, 2024
@traut traut closed this as completed in #222 Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant