github_gist publisher

blackstork/github, v1.0.0

Description #

Creates a GitHub Gist from the rendered document or updates an existing Gist when gist_id is provided.

Installation #

BlackStork SaaS: Plugin dependencies are resolved automatically by the platform. You do not need to install plugins or define the blackstork configuration block manually.

To use the github_gist publisher locally via blackstork-cli, you must declare the blackstork/github plugin as a dependency in your global configuration block.

blackstork {
  plugin_versions = {
    "blackstork/github" = ">= v1.0.0"
  }
}

After declaring the dependency, execute blackstork-cli install to fetch the plugin. See Configuration for details.

Configuration #

This publisher accepts the following configuration arguments within a config publish github_gist block:

config publish github_gist {
  # Required string.
  #
  # For example:
  github_token = "some string"
}

Usage #

This publisher accepts the following arguments within a publish github_gist block:

# The `publish` block also accepts the generic `format_ref` argument to link to a formatter.

publish github_gist {
  # Optional string.
  # Default value:
  description = null

  # Optional string.
  # Default value:
  filename = null

  # Optional bool.
  # Default value:
  make_public = false

  # Optional string.
  # Default value:
  gist_id = null
}