{"id":20301725,"url":"https://github.com/stpettersens/gulp-debian","last_synced_at":"2025-04-11T13:36:43.992Z","repository":{"id":57257311,"uuid":"54887573","full_name":"stpettersens/gulp-debian","owner":"stpettersens","description":":tropical_drink:  Gulp plug-in to create a Debian package.","archived":false,"fork":false,"pushed_at":"2022-12-25T00:20:39.000Z","size":99,"stargazers_count":7,"open_issues_count":5,"forks_count":10,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T09:49:27.185Z","etag":null,"topics":["debian","gulp-plugin","json","package","yaml"],"latest_commit_sha":null,"homepage":"https://libraries.io/npm/gulp-debian","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stpettersens.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-28T11:23:58.000Z","updated_at":"2024-02-26T17:24:57.000Z","dependencies_parsed_at":"2023-01-30T21:20:22.747Z","dependency_job_id":null,"html_url":"https://github.com/stpettersens/gulp-debian","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stpettersens%2Fgulp-debian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stpettersens%2Fgulp-debian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stpettersens%2Fgulp-debian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stpettersens%2Fgulp-debian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stpettersens","download_url":"https://codeload.github.com/stpettersens/gulp-debian/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248084278,"owners_count":21045123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debian","gulp-plugin","json","package","yaml"],"created_at":"2024-11-14T16:27:21.195Z","updated_at":"2025-04-11T13:36:43.970Z","avatar_url":"https://github.com/stpettersens.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"### gulp-debian\n\u003e :tropical_drink: Gulp plug-in to create a Debian package.\n\n\u003c!-- We need new CI\n[![Build Status](https://travis-ci.org/stpettersens/gulp-debian.png?branch=master)](https://travis-ci.org/stpettersens/gulp-debian)\n--\u003e\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)\n[![npm version](https://badge.fury.io/js/gulp-debian.svg)](http://npmjs.com/package/gulp-debian)\n\u003c!-- David DM seems to be gone\n[![Dependency Status](https://david-dm.org/stpettersens/gulp-debian.png?theme=shields.io)](https://david-dm.org/stpettersens/gulp-debian) [![Development Dependency Status](https://david-dm.org/stpettersens/gulp-debian/dev-status.png?theme=shields.io)](https://david-dm.org/stpettersens/gulp-debian?type=dev)\n--\u003e\n\n** Please note that this project [did not use](https://github.com/stpettersens/gulp-debian/issues/19) [semantic versioning](https://semver.org) prior to v1.0.0. It will be adopted as of that version. **\n\n##### Install\n\n    $ npm install --save-dev gulp-debian\n\n##### Usage\n\nDefine package in-line:\n\n```js\n'use strict'\n\nconst gulp = require('gulp')\nconst deb = require('gulp-debian')\n\ngulp.task('default', function (done) {\n  return gulp.src(['demo.sh','blob.bin'])\n  .pipe(deb({\n    package: 'demo',\n    version: '0.1-2',\n    section: 'base',\n    priority: 'optional',\n    architecture: 'i386',\n    maintainer: 'Mr. Apt \u003capt@nowhere.tld\u003e',\n    description: 'A dummy package\\n Long description starts here...',\n    preinst: [ 'echo \"hello from dummy package\"' ],\n    postinst: [ 'cat -n /opt/demo/.npmignore' ],\n    prerm: [ 'cat -n /opt/demo/.npmignore' ],\n    postrm: [ 'echo \"bye from dummy package\"' ],\n    conffiles: 'configs/dir',\n    changelog: [\n      {\n        version: '0.1-2',\n        distribution: 'unstable',\n        urgency: 'low',\n        date: new Date('2016-12-24T12:40:10'),\n        changes: [\n          'Added another feature.',\n          'Fixed feature X.'\n        ]\n      },\n      {\n        version: '0.1-1',\n        distribution: 'unstable',\n        urgency: 'low',\n        date: '2016-12-23T11:24:00',\n        changes: [\n          'First release.'\n        ]\n      }\n    ],\n    _target: 'opt/demo',\n    _out: 'dist',\n    _copyright: 'path/to/copyright',\n    _clean: true,\n    _verbose: true\n  }))\n  done()\n})\n```\n\nAlternatively, you can define your package in an external [JSON file](demo_0.1-2_i386.json):\n\n```js\ngulp.task('default', function (done) {\n  return gulp.src(['demo.sh', 'blob.bin'])\n  .pipe(deb('demo_0.1-2_i386.json'))\n  done()\n})\n```\n\nYou can also use a YAML file to define your package. Just convert it to an Object first using\nthe [js-yaml](https://github.com/nodeca/js-yaml) module (`npm install --save js-yaml`):\n\n```js\nconst YAML = require('js-yaml')\nconst fs = require('fs')\n\ngulp.task('default', function (done) {\n  return gulp.src(['demo.sh', 'blob.bin'])\n  .pipe(deb(YAML.load(fs.readFileSync('demo_0.1-2_i386.yml').toString())))\n  done()\n})\n```\n\n##### Options\n\n* Options: Object containing properties for a Debian file and the following parameters:\n    * preinst: String with a path to script or array of commands to run for the package's *pre-install* script (optional).\n    * postint: String with a path to script or array of commmands to run for the package's *post-install* script (optional).\n    * prerm: String with a path to script or array of commands to run for the package's *pre-remove* script (optional).\n    * postrm: String with a path to script or array of commmands to run for the package's *post-remove* script (optional).\n    * conffiles: string - path to the directory with configs. All configs must be placed from this directory in subdirectories starting from root folder (optional).\n    * changelog: Array of versions and their changes to write to the package's *changelog* (optional, but recommended). Options are:\n        * version: String for version with changes.\n        * distribution: String for version distribution.\n        * urgency: String for version urgency.\n        * date: Date object or String in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) notation for version date.\n        * changes: Array of changes made.\n    * _target: string - The installation target for the created Debian package (mandatory).\n    * _out: string - The target directory to create the Debian package in (mandatory).\n    * _copyright: string - The path to plain copyright file (functionally optional, but mandatory in [Debian policy](https://www.debian.org/doc/debian-policy/#copyright-information)).\n\n    This should be **mandatory** in packages you intend to publish, but for testing purposes\n    this can omitted for testing stage packages.\n\n    * _clean: boolean - If true, removes the temporary directory created in the target directory with the same structure than the Debian package.\n    * _verbose: boolean - Verbose output from dpkg-deb utility (optional; true if omitted).\n\n  (or)\n\n  * String containing filename for external JSON file defining package.\n\n##### Contributors\n\n* [Sam Saint-Pettersen](https://github.com/stpettersens)\n* [Oliver Skånberg-Tippen](https://github.com/oskanberg)\n* [Olaf Radicke](https://github.com/OlafRadicke)\n* [Míguel Ángel Mulero Martínez](https://github.com/McGiverGim)\n* [Alexey Lukomsky](https://github.com/lucomsky)\n* [haslinghuis](https://github.com/haslinghuis)\n* [Dominic Clifton](https://github.com/hydra)\n* [Gregory Marco](https://github.com/CatturaGreg)\n\n##### License\n\n[MIT](https://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstpettersens%2Fgulp-debian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstpettersens%2Fgulp-debian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstpettersens%2Fgulp-debian/lists"}