mirror of
https://github.com/Microsoft/vscode
synced 2024-08-27 04:49:35 +00:00
1e300d1f7e
The AppData files provide descriptive data about an application, and is typically used in application managers to display additional information to the user. Having an AppData file is especially important for some graphical application installers: without one, an application manager may not event show an entry for the application. This happens for example in GNOME Software. For the sake of completeness, this commit not only adds the AppData file to the Flatpak build, but also to the Linux .deb and .rpm packages.
288 lines
13 KiB
JavaScript
288 lines
13 KiB
JavaScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
'use strict';
|
|
|
|
const gulp = require('gulp');
|
|
const replace = require('gulp-replace');
|
|
const rename = require('gulp-rename');
|
|
const shell = require('gulp-shell');
|
|
const es = require('event-stream');
|
|
const vfs = require('vinyl-fs');
|
|
const util = require('./lib/util');
|
|
const packageJson = require('../package.json');
|
|
const product = require('../product.json');
|
|
const rpmDependencies = require('../resources/linux/rpm/dependencies');
|
|
|
|
const linuxPackageRevision = Math.floor(new Date().getTime() / 1000);
|
|
|
|
const flatpakManifest = {
|
|
appId: product.darwinBundleIdentifier, // We need a reverse-url style identifier.
|
|
sdk: 'org.freedesktop.Sdk',
|
|
runtime: 'org.freedesktop.Sdk',
|
|
runtimeVersion: '1.4',
|
|
base: 'io.atom.electron.BaseApp',
|
|
baseFlatpakref: 'https://s3-us-west-2.amazonaws.com/electron-flatpak.endlessm.com/electron-base-app-master.flatpakref',
|
|
command: product.applicationName,
|
|
symlinks: [
|
|
['/share/' + product.applicationName + '/bin/' + product.applicationName, '/bin/' + product.applicationName],
|
|
],
|
|
finishArgs: [
|
|
'--share=ipc', '--socket=x11', // Allow showing X11 windows.
|
|
'--share=network', // Network access (e.g. for installing extension).
|
|
'--filesystem=host', // Allow access to the whole file system.
|
|
'--device=dri', // Allow OpenGL rendering.
|
|
'--filesystem=/tmp', // Needed for Chromium's single instance check.
|
|
'--socket=pulseaudio', // Some extensions may want to play sounds...
|
|
'--talk-name=org.freedesktop.Notifications', // ...or pop up notifications.
|
|
],
|
|
};
|
|
|
|
|
|
function getDebPackageArch(arch) {
|
|
return { x64: 'amd64', ia32: 'i386', arm: 'armhf' }[arch];
|
|
}
|
|
|
|
function prepareDebPackage(arch) {
|
|
const binaryDir = '../VSCode-linux-' + arch;
|
|
const debArch = getDebPackageArch(arch);
|
|
const destination = '.build/linux/deb/' + debArch + '/' + product.applicationName + '-' + debArch;
|
|
|
|
return function () {
|
|
const desktop = gulp.src('resources/linux/code.desktop', { base: '.' })
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME_SHORT@@', product.nameShort))
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(rename('usr/share/applications/' + product.applicationName + '.desktop'));
|
|
|
|
const appdata = gulp.src('resources/linux/code.appdata.xml', { base: '.' })
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(replace('@@LICENSE@@', product.licenseName))
|
|
.pipe(rename('usr/share/appdata/' + product.applicationName + '.appdata.xml'));
|
|
|
|
const icon = gulp.src('resources/linux/code.png', { base: '.' })
|
|
.pipe(rename('usr/share/pixmaps/' + product.applicationName + '.png'));
|
|
|
|
const code = gulp.src(binaryDir + '/**/*', { base: binaryDir })
|
|
.pipe(rename(function (p) { p.dirname = 'usr/share/' + product.applicationName + '/' + p.dirname; }));
|
|
|
|
let size = 0;
|
|
const control = code.pipe(es.through(
|
|
function (f) { size += f.isDirectory() ? 4096 : f.contents.length; },
|
|
function () {
|
|
const that = this;
|
|
gulp.src('resources/linux/debian/control.template', { base: '.' })
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(replace('@@VERSION@@', packageJson.version + '-' + linuxPackageRevision))
|
|
.pipe(replace('@@ARCHITECTURE@@', debArch))
|
|
.pipe(replace('@@INSTALLEDSIZE@@', Math.ceil(size / 1024)))
|
|
.pipe(rename('DEBIAN/control'))
|
|
.pipe(es.through(function (f) { that.emit('data', f); }, function () { that.emit('end'); }));
|
|
}));
|
|
|
|
const prerm = gulp.src('resources/linux/debian/prerm.template', { base: '.' })
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(rename('DEBIAN/prerm'));
|
|
|
|
const postrm = gulp.src('resources/linux/debian/postrm.template', { base: '.' })
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(rename('DEBIAN/postrm'));
|
|
|
|
const postinst = gulp.src('resources/linux/debian/postinst.template', { base: '.' })
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(replace('@@ARCHITECTURE@@', debArch))
|
|
.pipe(replace('@@QUALITY@@', product.quality || '@@QUALITY@@'))
|
|
.pipe(replace('@@UPDATEURL@@', product.updateUrl || '@@UPDATEURL@@'))
|
|
.pipe(rename('DEBIAN/postinst'));
|
|
|
|
const all = es.merge(control, postinst, postrm, prerm, desktop, appdata, icon, code);
|
|
|
|
return all.pipe(vfs.dest(destination));
|
|
};
|
|
}
|
|
|
|
function buildDebPackage(arch) {
|
|
const debArch = getDebPackageArch(arch);
|
|
return shell.task([
|
|
'chmod 755 ' + product.applicationName + '-' + debArch + '/DEBIAN/postinst ' + product.applicationName + '-' + debArch + '/DEBIAN/prerm ' + product.applicationName + '-' + debArch + '/DEBIAN/postrm',
|
|
'mkdir -p deb',
|
|
'fakeroot dpkg-deb -b ' + product.applicationName + '-' + debArch + ' deb',
|
|
'dpkg-scanpackages deb /dev/null > Packages'
|
|
], { cwd: '.build/linux/deb/' + debArch});
|
|
}
|
|
|
|
function getRpmBuildPath(rpmArch) {
|
|
return '.build/linux/rpm/' + rpmArch + '/rpmbuild';
|
|
}
|
|
|
|
function getRpmPackageArch(arch) {
|
|
return { x64: 'x86_64', ia32: 'i386', arm: 'armhf' }[arch];
|
|
}
|
|
|
|
function prepareRpmPackage(arch) {
|
|
const binaryDir = '../VSCode-linux-' + arch;
|
|
const rpmArch = getRpmPackageArch(arch);
|
|
|
|
return function () {
|
|
const desktop = gulp.src('resources/linux/code.desktop', { base: '.' })
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME_SHORT@@', product.nameShort))
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(rename('BUILD/usr/share/applications/' + product.applicationName + '.desktop'));
|
|
|
|
const appdata = gulp.src('resources/linux/code.appdata.xml', { base: '.' })
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(replace('@@LICENSE@@', product.licenseName))
|
|
.pipe(rename('usr/share/appdata/' + product.applicationName + '.appdata.xml'));
|
|
|
|
const icon = gulp.src('resources/linux/code.png', { base: '.' })
|
|
.pipe(rename('BUILD/usr/share/pixmaps/' + product.applicationName + '.png'));
|
|
|
|
const code = gulp.src(binaryDir + '/**/*', { base: binaryDir })
|
|
.pipe(rename(function (p) { p.dirname = 'BUILD/usr/share/' + product.applicationName + '/' + p.dirname; }));
|
|
|
|
const spec = gulp.src('resources/linux/rpm/code.spec.template', { base: '.' })
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@VERSION@@', packageJson.version))
|
|
.pipe(replace('@@RELEASE@@', linuxPackageRevision))
|
|
.pipe(replace('@@ARCHITECTURE@@', rpmArch))
|
|
.pipe(replace('@@LICENSE@@', product.licenseName))
|
|
.pipe(replace('@@QUALITY@@', product.quality || '@@QUALITY@@'))
|
|
.pipe(replace('@@UPDATEURL@@', product.updateUrl || '@@UPDATEURL@@'))
|
|
.pipe(replace('@@DEPENDENCIES@@', rpmDependencies[rpmArch].join(', ')))
|
|
.pipe(rename('SPECS/' + product.applicationName + '.spec'));
|
|
|
|
const specIcon = gulp.src('resources/linux/rpm/code.xpm', { base: '.' })
|
|
.pipe(rename('SOURCES/' + product.applicationName + '.xpm'));
|
|
|
|
const all = es.merge(code, desktop, appdata, icon, spec, specIcon);
|
|
|
|
return all.pipe(vfs.dest(getRpmBuildPath(rpmArch)));
|
|
};
|
|
}
|
|
|
|
function buildRpmPackage(arch) {
|
|
const rpmArch = getRpmPackageArch(arch);
|
|
const rpmBuildPath = getRpmBuildPath(rpmArch);
|
|
const rpmOut = rpmBuildPath + '/RPMS/' + rpmArch;
|
|
const destination = '.build/linux/rpm/' + rpmArch;
|
|
|
|
return shell.task([
|
|
'mkdir -p ' + destination,
|
|
'HOME="$(pwd)/' + destination + '" fakeroot rpmbuild -bb ' + rpmBuildPath + '/SPECS/' + product.applicationName + '.spec --target=' + rpmArch,
|
|
'cp "' + rpmOut + '/$(ls ' + rpmOut + ')" ' + destination + '/',
|
|
'createrepo ' + destination
|
|
]);
|
|
}
|
|
|
|
function getFlatpakArch(arch) {
|
|
return { x64: 'x86_64', ia32: 'i386', arm: 'arm' }[arch];
|
|
}
|
|
|
|
function prepareFlatpak(arch) {
|
|
const binaryDir = '../VSCode-linux-' + arch;
|
|
const flatpakArch = getFlatpakArch(arch);
|
|
const destination = '.build/linux/flatpak/' + flatpakArch;
|
|
|
|
return function () {
|
|
// This is not imported in the global scope to avoid requiring ImageMagick
|
|
// (or GraphicsMagick) when not building building Flatpak bundles.
|
|
const imgResize = require('gulp-image-resize');
|
|
|
|
const all = [16, 24, 32, 48, 64, 128, 192, 256, 512].map(function (size) {
|
|
return gulp.src('resources/linux/code.png', { base: '.' })
|
|
.pipe(imgResize({ width: size, height: size, format: "png", noProfile: true }))
|
|
.pipe(rename('share/icons/hicolor/' + size + 'x' + size + '/apps/' + flatpakManifest.appId + '.png'));
|
|
});
|
|
|
|
all.push(gulp.src('resources/linux/code.desktop', { base: '.' })
|
|
.pipe(replace('Exec=/usr/share/@@NAME@@/@@NAME@@', 'Exec=' + product.applicationName))
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME_SHORT@@', product.nameShort))
|
|
.pipe(replace('@@NAME@@', product.applicationName))
|
|
.pipe(rename('share/applications/' + flatpakManifest.appId + '.desktop')));
|
|
|
|
all.push(gulp.src('resources/linux/code.appdata.xml', { base: '.' })
|
|
.pipe(replace('@@NAME_LONG@@', product.nameLong))
|
|
.pipe(replace('@@NAME@@', flatpakManifest.appId))
|
|
.pipe(replace('@@LICENSE@@', product.licenseName))
|
|
.pipe(rename('share/appdata/' + flatpakManifest.appId + '.appdata.xml')));
|
|
|
|
all.push(gulp.src(binaryDir + '/**/*', { base:binaryDir })
|
|
.pipe(rename(function (p) {
|
|
p.dirname = 'share/' + product.applicationName + '/' + p.dirname;
|
|
})));
|
|
|
|
return es.merge(all).pipe(vfs.dest(destination));
|
|
}
|
|
}
|
|
|
|
function buildFlatpak(arch) {
|
|
const flatpakArch = getFlatpakArch(arch);
|
|
const manifest = {};
|
|
for (var k in flatpakManifest) {
|
|
manifest[k] = flatpakManifest[k];
|
|
}
|
|
manifest.files = [
|
|
['.build/linux/flatpak/' + flatpakArch, '/'],
|
|
];
|
|
const buildOptions = {
|
|
arch: flatpakArch,
|
|
subject: product.nameLong + ' ' + packageJson.version + '.' + linuxPackageRevision,
|
|
};
|
|
// If requested, use the configured path for the OSTree repository.
|
|
if (process.env.FLATPAK_REPO) {
|
|
buildOptions.repoDir = process.env.FLATPAK_REPO;
|
|
} else {
|
|
buildOptions.bundlePath = manifest.appId + '-' + flatpakArch + '.flatpak';
|
|
}
|
|
// Setup PGP signing if requested.
|
|
if (process.env.GPG_KEY_ID !== undefined) {
|
|
buildOptions.gpgSign = process.env.GPG_KEY_ID;
|
|
if (process.env.GPG_HOMEDIR) {
|
|
buildOptions.gpgHomedir = process.env.GPG_HOME_DIR;
|
|
}
|
|
}
|
|
return function (cb) {
|
|
require('flatpak-bundler').bundle(manifest, buildOptions, cb);
|
|
}
|
|
}
|
|
|
|
gulp.task('clean-vscode-linux-ia32-deb', util.rimraf('.build/linux/deb/i386'));
|
|
gulp.task('clean-vscode-linux-x64-deb', util.rimraf('.build/linux/deb/amd64'));
|
|
gulp.task('clean-vscode-linux-arm-deb', util.rimraf('.build/linux/deb/armhf'));
|
|
gulp.task('clean-vscode-linux-ia32-rpm', util.rimraf('.build/linux/rpm/i386'));
|
|
gulp.task('clean-vscode-linux-x64-rpm', util.rimraf('.build/linux/rpm/x86_64'));
|
|
gulp.task('clean-vscode-linux-arm-rpm', util.rimraf('.build/linux/rpm/armhf'));
|
|
|
|
gulp.task('vscode-linux-ia32-prepare-deb', ['clean-vscode-linux-ia32-deb', 'vscode-linux-ia32-min'], prepareDebPackage('ia32'));
|
|
gulp.task('vscode-linux-x64-prepare-deb', ['clean-vscode-linux-x64-deb', 'vscode-linux-x64-min'], prepareDebPackage('x64'));
|
|
gulp.task('vscode-linux-arm-prepare-deb', ['clean-vscode-linux-arm-deb', 'vscode-linux-arm-min'], prepareDebPackage('arm'));
|
|
gulp.task('vscode-linux-ia32-build-deb', ['vscode-linux-ia32-prepare-deb'], buildDebPackage('ia32'));
|
|
gulp.task('vscode-linux-x64-build-deb', ['vscode-linux-x64-prepare-deb'], buildDebPackage('x64'));
|
|
gulp.task('vscode-linux-arm-build-deb', ['vscode-linux-arm-prepare-deb'], buildDebPackage('arm'));
|
|
|
|
gulp.task('vscode-linux-ia32-prepare-rpm', ['clean-vscode-linux-ia32-rpm', 'vscode-linux-ia32-min'], prepareRpmPackage('ia32'));
|
|
gulp.task('vscode-linux-x64-prepare-rpm', ['clean-vscode-linux-x64-rpm', 'vscode-linux-x64-min'], prepareRpmPackage('x64'));
|
|
gulp.task('vscode-linux-arm-prepare-rpm', ['clean-vscode-linux-arm-rpm', 'vscode-linux-arm-min'], prepareRpmPackage('arm'));
|
|
gulp.task('vscode-linux-ia32-build-rpm', ['vscode-linux-ia32-prepare-rpm'], buildRpmPackage('ia32'));
|
|
gulp.task('vscode-linux-x64-build-rpm', ['vscode-linux-x64-prepare-rpm'], buildRpmPackage('x64'));
|
|
gulp.task('vscode-linux-arm-build-rpm', ['vscode-linux-arm-prepare-rpm'], buildRpmPackage('arm'));
|
|
|
|
gulp.task('clean-vscode-linux-ia32-flatpak', util.rimraf('.build/linux/flatpak/i386'));
|
|
gulp.task('clean-vscode-linux-x64-flatpak', util.rimraf('.build/linux/flatpak/x86_64'));
|
|
gulp.task('clean-vscode-linux-arm-flatpak', util.rimraf('.build/linux/flatpak/arm'));
|
|
|
|
gulp.task('vscode-linux-ia32-prepare-flatpak', ['clean-vscode-linux-ia32-flatpak', 'vscode-linux-ia32-min'], prepareFlatpak('ia32'));
|
|
gulp.task('vscode-linux-x64-prepare-flatpak', ['clean-vscode-linux-x64-flatpak', 'vscode-linux-x64-min'], prepareFlatpak('x64'));
|
|
gulp.task('vscode-linux-arm-prepare-flatpak', ['clean-vscode-linux-arm-flatpak', 'vscode-linux-arm-min'], prepareFlatpak('arm'));
|
|
|
|
gulp.task('vscode-linux-ia32-flatpak', ['vscode-linux-ia32-prepare-flatpak'], buildFlatpak('ia32'));
|
|
gulp.task('vscode-linux-x64-flatpak', ['vscode-linux-x64-prepare-flatpak'], buildFlatpak('x64'));
|
|
gulp.task('vscode-linux-arm-flatpak', ['vscode-linux-arm-prepare-flatpak'], buildFlatpak('arm'));
|