Need help with other JFrog products?
Good news! Enterprise-scale distribution is now handled through the robust JFrog Platform.
Please contact us with any questions.
Creating a New Package
Creating a package is a mandatory step in the process of uploading data into the structured order of the Bintray system. Packages can only be created by logged-in users who already own at least one repository (or by users who are members of an organization that has at least one repository). When a package is created, ownership of it is assigned to whoever owns the repository (a user or an organization). Since any package in Bintray must be in a repository, the very creation of a package already starts within a repository, from the Repository page.
To create a new package:
Access the Repository page of the repository where you want the package to be located and click Add New Package.
The Create New Package page is displayed.
2. Enter the info (package metadata) and click Save Changes to create the package.
The package is created and the Edit Package page is displayed for continued editing (clicking the Cancel button sends you to the Package page if you want to view the package rather than continue editing it).
Editing a Package
The details of an existing package may be edited when necessary. Editing a package can only be done by its owner (or, if the package belongs to a repository that is within an organization, by any member with the proper authorization).
Note that editing a package means editing its metadata details (and even some of these cannot be changed after initial creation of the package); it does not mean editing the data in it (which is done by adding versions and uploading files manually or link:uploads_uploadingusingapis.html[with tools).
To edit a package’s details:
Access the relevant Package page.
Click the Edit button under the package name.
The Edit Package page is displayed, showing its Package Details form where you can change the package metadata.
Don’t forget to click Update Package when you are done.
Screenshots of the software may be attached to any package; they accompany the files uploaded to the versions of the package. These screenshots can be anything that the uploading user considers relevant for the downloaders informing about or promoting the software. Only the package owner may upload these screenshots (or, if the package belongs to an organization, any user in the organization with authorization to edit the package). Note that all the regular rules and guidelines of copyright still apply.
To attach screenshots to a package, simply click the Upload a file link next to the Screenshots category and select a graphic file from the browse dialog box that opens.
The attached files are displayed as thumbnails in the form.
The screenshots also appear in the General tab of the Package page.
Additionally, when a package (or any version within the package) has screenshots, the package avatar, as displayed in the Repository page, is marked with the Screenshots indication, placed at the upper right corner of the package avatar.
Just like there are package screenshots, there are also screenshots specific to a version.
If this package is stored in a Premium Repository, you can control who can view the stats for the package.
If the Public stats box is checked, then anyone can view the stats, but if the box is not checked, only users with publish permission for this package can view the stats. Other users will not see a Stats tab when viewing this package. If you allow users to access the Stats tab for this package, you can still decide whether to allow them to view download stats or not using the Make download numbers in stats public checkbox.
Package Attributes (Attributes List)
Package attributes are user-defined attributes of a package in addition to the default version metadata fields. User-defined means that you can set the name of field of data itself (the category), not just assign a value to it.
To add or edit package attributes, click the Attributes List link on the left navigation bar. In the Attributes List form, to add a new attribute, simply click the Add New Attribute link, or click the "Edit" icon to change the value of an existing attribute (you cannot change the name of an attribute once it has been created).
You can add as many user-defined attributes to a package as you like.
Don’t forget to click the Update button (the "plus" sign on the right ) when you are done adding or editing each attribute.
The new attributes appear in the General tab of the Package page.
In the Versions List form, you can change the order in which versions are displayed in the Package page by simply dragging the various version entries to change the order.
To save the reordering, click Save Changes.
Note: In the Versions List form, each version’s entry includes an Edit link, which you can click in order to edit the version.
The Permissions form shows which entitlements you have created will provide access to this package.
The metadata fields that define a package are as follows:
In the Package Details form:
Package Avatar: The avatar assigned to the package may be uploaded by the user (as an image file) at any time. If no avatar is uploaded, a generic one is automatically assigned.
Owner: The owner of the user is the same owner as the repository in which the package was created (user or organization).
Name: Entered by the user at the time of the creation of the package; may be changed later.
Description: Free text that is added optionally by users who care about informing people about their package. This text description may be entered at the time of the creation of the package and it may be edited at any time later.
Licenses: Any licenses that apply to the software in the package. The license can be selected from a drop-down list of industry standard OSS licenses in the Bintray UI, requested as a new OSS license, or created as a proprietary license(available only for premium plan).
Note: This field is mandatory for OSS packages.
Tags: Text tags are keywords and/or terms assigned to the package according to topic or theme and are designed to help other users search for the package. Tags may (optionally) be entered either at the time of the package’s creation and may (optionally) be edited at any time later.
Screenshots: Screenshots of your software that you want to include for better understanding and promotion.
Website: The URL to your own website or to the website featuring the software in your package.
Issues Tracker: The URL to an issue-tracking system (a.k.a. bug-tracking system or defect-tracking system) where fellow developers can follow and help you solve bugs and defects (JIRA, Trac, Bugzilla, etc.)
Version Control: The URL to a version control system (a.k.a. revision-control system) where your package’s sources are managed (Git, SVN, CVS, etc.)
GitHub Repo (User/Repo): For the purpose of Importing Readmes and Release Notes from GitHub to BintrayTBD LINK, this field is used to indicate from which repository in GitHub the files are to be imported (the format of the info in this field is the username in GitHub, followed by a slash and then followed by the repository name, for example, “octocat/Hello-World”).
GitHub Release Notes File: For the purpose of importing a release notes file from GitHub (to serve as release notes for the package in Bintray), this field indicates the folder and filename (under the repository indicated in the field GitHub repo) of the release notes file in GitHub (note that this field is only enabled if there is a valid value in the field GitHub Repo).
Make Download Numbers in Stats Public Checkbox: When statistics for your package are displayed in Bintray, you have the option of displaying them with or without the specific numbers of downloads. Without the numbers, the statistics will show the relative popularity of the different versions, the countries from which people downloaded more or fewer times material from your package and the dates on which there were more or less downloads. With the numbers (this checkbox is unchecked by default) the users can also know exactly how many downloads there were.
In the Attributes List form:
Package attributes are user-defined attributes in addition to the default package metadata fields. User-defined means that the user can decide the name of field of data itself (the category), not just assigning a value to it.
A package may have several such user-defined attributes.
In the Versions List form:
The versions of this package, in the order in which they will be displayed in the Package page. This order can be changed in this tab (by drag-and-dropping).
Linking to Packages from External Sites
Bintray makes it easy for you to create links to your packages by generating HTML code that you can embed directly on your own website. The Version Notification Link will help a user watch your package by taking him directly to Bintray where he can register to receive notifications whenever a new version of your package is uploaded. The Latest Version Download Badge will download the latest version of your package.
To Create a Version Notification Link:
Access the relevant package page.
Click the Version Notification Links button.
A message displays three badges you can select to display on your website, along with the corresponding HTML code needed to embed them.
3 Select the badge you want to display and then click the Copy to Clipboard button to copy the corresponding HTML text to the clipboard.
4. Paste the HTML code into the right place in your website source files.
To Create a Latest Version Download Badge:
Access the relevant package page.
Click the Latest Version Badge button.
A message displays the code you need to embed in order to display the badge.
3. The code is available in Markdown, AsciiDoc and HTML formats. Select the tab for the format you want and then click the Copy to Clipboard button to copy the corresponding code to the clipboard.
4. Paste the code into the source file representing the place you want to display the badge
Reporting Ownership of Packages