Have a question? Want to report an issue? Contact JFrog support

Skip to end of metadata
Go to start of metadata

Overview 

As soon as you have set up a Bintray repository, you can add packages to it. A package is a logical unit including a set of package versions contained in a repository. Each package version contains artifacts and metadata designed to fulfill a particular function. Packages and their versions can be created through Bintray UI, Bintray API and by using the supported native clients like Maven, Docker and others.


You can create, edit and manage your packages, as follows: 

  • Manually create a package. You can create a package from the Repository page or thorugh API or through native clients.

  • When you edit a package you modify the information around the uploaded material such as licensing, and external references (the package metadata), not its versions or files). Editing a package may also include adding user-defined attributes (or modifying existing ones) to a package.

  • Add Readme text and/or release notes to a package.

  • Create a new version in the package. A version must be created if files are to be uploaded.

  • Create a download list for the version. A download list is a quick-reference link to download the key files of the package.

  • Merge several packages into one. The new consolidated package will include the versions and files of all its component packages but inherits its metadata only from the source package in the merge.

  • Include your package in a central repository or link your package to a repository belonging to an organization of which you are a member (with the relevant authorizations).

  • Read user reviews about your package. If there are reviews, you can note whether they were helpful or not and also reply to them.

  • View the download stats of your package and its versions. Get information about how many times and when each version of your package has been downloaded.

Page Contents


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.

The package metadata is set when the package is created and may be changed when the package is edited later. Package metadata is lost only if the package is merged into another package.

Note that when displayed in Bintray, additional information about a package (not only the metadata) is displayed (versions, reviews, number of watchers, etc.)

 

  1. Access the Repository page of the repository where you want the package to be located and click Add a Package.
    The Add Package page is displayed.
  2. Enter the info (package metadata) and click Save to create the package.
    Now that the package is created, versions can be added to it, the package can be linked to another repository and/or included in JCenter, it can be merged with other packages and it can be edited.
  3. Set the Package attributes wjat are user-defined attributes in addition to the default package metadata fields. You can set the 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. 

    The Cancel button sends you to the Package page if you want to view the package rather than continue editing it.

 

Package Avatar

Sets 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).

Mandatory Field

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.
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.)
Vcs
  • 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 Bintray, 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”). 

Make Download Numbers in Stats Public
Displays statistics for your package 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.

 

Viewing and 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 with tools). 

 

In the Package page, click Actions > Edit.

 

Screenshots

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 Overview 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.  

 

Statistics 

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 Custom Attributes List link on the left navigation bar. In the Attributes List form, to add a new attribute, simply click the Add 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.

Versions 

Package Versions are displayed in the package Overview tab, 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.

In the Versions List form, each version’s entry includes an Edit link, which you can click in order to edit the version.

 

Permissions 

The Permissions form shows which entitlements you have created will provide access to this package.

 


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:

  1. Access the relevant package page.

  2. Click the Badge icon for the relevant version.



 

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:

  1. Access the relevant package page.

  2. Click the Badge icon.
    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 icon 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.


Setting Watches and Reviews on Packages

Setting a watch on a package generates an email updating when a new version is released.

From the Community tab on the Package page set the watches and packages to be reviewed In the Community tab on the Package page.

Reviews can be added only to published packages.


 


Reporting Ownership of Packages 

If you spot a package that should belong to you, or a user you know, but instead, is included as part of a central repository (a repository owned by the Bintray team), click the I’m the creator or I know the creator link in the Package page or in the package’s entry in the relevant Repo page. 


Clicking any of these links opens a Message page from which you can send your message informing the Bintray team that this is your or someone else’s package, providing proof and suggesting the ownership change.
If ownership is indeed transferred from the central repository to a user, this user is notified by a message and prompted to select into which repository this package is to be moved. Note that the same package is also automatically included (linked) to the central repository in which it once was placed (for the sake of those users who relied on its being there).
  • No labels