Skip to content

Instantly share code, notes, and snippets.

@dvarrazzo
Last active January 13, 2016 11:23
Show Gist options
  • Save dvarrazzo/137060aacc1b93de99f4 to your computer and use it in GitHub Desktop.
Save dvarrazzo/137060aacc1b93de99f4 to your computer and use it in GitHub Desktop.
Hypothetical definition of a PGXN package description in YAML
# This file specifies all information for a PGXN distribution. Full spec is at
# http://pgxn.org/spec/ *NOTE* A single distribution can contain multiple
# extensions! See http://pgxn.org/spec/#Terminology.
#
# Keys marked REQUIRED or Optional are what you'd expect. Keys marked Unusual
# are keys you don't normally need to use. The pgxntool Makefile will strip
# out empty keys to produce a working META.json, so it's fine to leave them
# here.
# REQUIRED. Name of distribution.
name: ""
# REQUIRED. Version of the distribution. http://pgxn.org/spec/#version
version: 0.1.0
# REQUIRED. Short description of distribution.
abstract: ""
# Optional. A longer description of the distribution.
# http://pgxn.org/spec/#description
description: ""
# REQUIRED. Contact info for distribution maintainers.
# http://pgxn.org/spec/#maintainer
maintainer":
- "Your Name <Your@Email>"
# Optional. Status of distribution. Allowed values: unstable, testing, stable
release_status: unstable
# REQUIRED. License(s) distribution is released under.
# http://pgxn.org/spec/#license
license: postgresql
# REQUIRED. Specifies extensions contained in this distribution. Each key is
# the name of an extension. http://pgxn.org/spec/#provides
provides:
- EXTENSION NAME:
# REQUIRED. File containing extension.
file: sql/file.sql
# REQUIRED. Version the extension is at.
version: 0.1.0
# Optional: Description of the extension.
abstract: ""
# Optional: filesystem path to document file for extension.
docfile: ""
# LIST of TAGS for the distribution. http://pgxn.org/spec/#tags
tags: [ "foo", "bar" ]
# Optional. Web resources available for this distribution.
# http://pgxn.org/spec/#resources
resources:
homepage: http://github.com/BlueTreble/test_factory/
bugtracker:
web: http://github.com/BlueTreble/test_factory/issues
repository:
url: git://github.com/BlueTreble/test_factory.git
web: http://github.com/BlueTreble/test_factory/
type: git
# Optional: Prerequisits for the distribution. http://pgxn.org/spec/#prereqs
prereqs:
# Valid keys are configure, build, runtime, or test.
build:
requires:
PostgreSQL: "9.5.0"
runtime:
requires":
plpgsql: 0
test:
requires:
pgtap: 0
# Unusual. Files/directories that should not be indexed.
# http://pgxn.org/spec/#no_index
no_index":
file:
- src/file.sql
directory:
- src/private
# Unusual. Package/tool used to generate this file.
generated_by: pgxntool https://github.com/decibel/pgxntool
# REQUIRED. Version info for this file. http://pgxn.org/spec/#meta-spec",
meta-spec:
version: 1.0.0
url: http://pgxn.org/meta/spec.txt
# vi: expandtab ts=4 sw=4"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment