Describe the basic information of the Nep package, the table is located at package.toml
.
General information table.
Package name, it is recommended to use only English, Chinese, and spaces.
Do not include underscores (_
), please use spaces or hyphens (-
) instead.
String
name = "VSCode"
A brief description of the package, try to extract the introduction from official channels.
String
description = "A cross-platform open-source editor developed by Microsoft"
Package template, in the current version, it can only be "Software".
String Enum
Software
template = "Software"
Package version number, using ExSemVer specification.
ExSemVer specification adds a RESERVED
bit between PATCH
and PRE
based on SemVer, which is used to mark different packaging versions or to be compatible with the common 4-digit version numbers on the Windows platform; if the upstream version number conforms to SemVer specification, then set the RESERVED
bit to 0
.
String
version = "1.0.0.0"
Package authors, the first author should be the packager, followed by the distributor, producer, etc.
Supports wrapping author email with <>
.
Vec<String>
authors = ["Cno <dsyourshy@qq.com>", "Microsoft"]
Optional Open-source license SPDX identifier or EULA link.
String
license = "MIT"
Optional Package icon URL.
String
icon = "https://code.visualstudio.com/favicon.ico"
Optional Whether to use strict mode, the default is true
.
When strict mode is enabled, if an error occurs in a step, the workflow will immediately stop execution and report an error; otherwise, the workflow will only warn of the error and continue to run the subsequent steps.
Note that if you want to use the built-in variable ExitCode
, please set strict
to false
.
bool
strict = false
Software package exclusive table.
Software distribution domain, usually fill in the name of the upstream organization.
If the direct upstream of the software package is the distributor/organization, use the distributor's name, such as PortableApps
; if the direct upstream of the software package is the official website, use the developer's/organization's name, such as Microsoft
.
If the upstream organization is a formal organization with an independent domain name, capitalize the beginning of the distribution domain, such as using GitHub
as the distribution domain for GitHub Desktop
published by GitHub; if the upstream organization represents a general reference to a group, use a lowercase beginning for the distribution domain, such as using github
as the distribution domain for open-source projects hosted on GitHub Releases.
String
scope = "Microsoft"
Software upstream URL, which can be the official website's download page or the distribution details page provided by the distributor/organization.
String
upstream = "https://code.visualstudio.com/"
Software category, it is recommended to be one of the Edgeless plugin package categories.
String
category = "Integrated Development"
Optional The target architecture of the software compilation, the default indicates that the architecture compatibility is not checked during installation.
String Enum
X64
X86
ARM64
arch = "X64"
Software language, Multi
indicates multiple languages.
String Enum
Multi
zh-CN
en-US
language = "Multi"
Optional Main program path, which can be a relative or absolute path.
If using an absolute path, it must start with a built-in variable.
String
Optional Tags, used for recommending similar packages or aggregating multiple closely related packages.
Do not repeat information from the package name, category, or author name.
Vec<String>
tags = ["electron", "typescript"]
Optional Aliases, used for associative lookup.
Do not repeat information from the tags.
Vec<String>
alias = ["code", "vsc", "Visual Studio Code"]
Optional Registry entry, if the software is installed by calling an installer and has an Uninstall entry in the registry, providing this field can eliminate the need to write an uninstall workflow and help ept obtain more information.
Supports entries in the following 3 locations:
String