Page Contents

Overview

After you have uploaded your material you need to ensure that the right users can access it, and can that you can authenticate your material to them. Bintray offers several options for you to choose how to provide the user with convenient links to download your material (when it is ready) in the relevant context, and options for other relevant support of your uploaded material. These options include:

  • Changing the status of your packages and versions so that other users can see and download the files you have uploaded; as long as a file is unpublished, only the user who uploaded them can see it. This gives the user who has uploaded files time to verify or test the upload before users start downloading it.

  • Adding extra information about your packages and versions such as readme texts and release notes. This information can be viewed in the Bintray UI without the need to download anything.

  • Creating a download list for Bintray packages and versions. The user who owns the package or version can create a list of files recommended for download, or a shortcut list for downloading the newest, most important or most popular files from within his or her package or version.

  • Using the optional GPG Signing feature (currently available for Maven repositories) to sign your material so that it can be verified as authentic and original by other users. This feature uses an ASCII-armored key pair.

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

  • Deleting your content from Bintray.

In addition, Bintray also offers other options that are more specifically intended to promote your content.

Publishing

Publishing basically means that other users can see and download the files you have uploaded. Only uploaded files (not repos, packages, versions or user profiles) can ever have the status of unpublished. This gives the uploading user time to change his or her mind about the upload or to verify or test it. After 24 hours, unpublished files are deleted from Bintray. Note that since unpublished is the default status of an uploaded file, every file manually uploaded must be manually published. Unpublished files are only visible and accessible on Bintray to the user who uploaded them; once these files are uploaded the right and ability to publish them belongs to this user.

Unpublished files may be discarded if a problem is discovered in them within 24-hours from the file’s upload. However, if a problem is discovered in a file after publication, there is an extra 30-day grace period, during which the file may be deleted.

To manually publish an uploaded file:

  1. Access the Version page after a file has been uploaded (if not already displayed by default).

    A message is displayed, including the option to either discard or publish the file (the same message appears also in the Package page and Repo page of the package and repository that contains this version).

    Unpublished items (Version)

  2. In the message, click the Publish link.

    The uploaded file is now visible and available in the Version page’s Files tab and a note about the version including published files appears in the Version page’s General tab (at the top of the right column).

    Additionally, a message appears confirming the successful publishing.
    Published file with Twitter icon

    Note: You can click the Tweet This New Version Release link to post a tweet notifying your followers about the new version, now that it has published files.
    Alternatively, click the Discard link to discard the file (it will not be displayed at all in Bintray).

Note: If there are unpublished files in two (or more…​ versions within the same package, the message of unpublished items that is displayed in the Package page will acknowledge all of them. It is possible to publish the files of one of the versions without publishing the files of any other version. This is done by right-clicking the More icon on the right side of the message and selecting the relevant version from the drop-down list.

Note: This procedure applies to manually publishing a file through the Bintray UI. It is also possible to publish a file automatically, along with the file’s automatic upload.

Providing Information about Your Packages and Versions

To ensure that your packages and versions are downloaded by right user, and they know how to use them appropriately, you can provide some extra information.

This information can include a short readme text or release notes.

Bintray enables the user to view the readme and the release notes without downloading anything, to determine whether he or she wants to download your packages or versions. The readme and release notes are texts displayed and can be read directly in the Bintray interface.

You can add a readme text to a package and its versions (one readme text per package, shared between the package itself and all its versions). You can add release notes for a package or for each of its versions.

Note, however, that the readme and release notes are not the only types of extra information you can provide: in addition to the brief description added in the initial creation of a package or version (or the later editing of a package or version), you can also include screenshots to help the user understand the software in the packages and versions.

Adding a Readme text file to Packages and/or Versions

You can add a readme text to packages and its versions (one readme text per package, shared between the package itself and all its versions). There are two options of how to create the readme file: add/edit text in the Bintray UI (this text can be Markdown, ASCII Doc or plain text) or import a readme file from GitHub.

To add readme to a package or version:

  1. Access the relevant Package or Version page and select the Readme tab.

  2. From the drop-down menu select the Bintray option (if not already selected by default) and then click Edit.

    Use readme from (Readme, Pckg)

  3. In the text box that opens, select which text format you want to use from the dropdown menu.
    The options are: Markdown, ASCII Doc and Plain Text.
    Note: Click here for full information about how to use markdown syntax; click here for full information about how to use ASCII Doc or just type your Readme notes in plain text.

    Syntax (Readme tab, Package)

  4. In the text box, type the text of the Readme notes for the package or version.

    Note: While typing, you can click the Preview button at any time to see what the text will look like when it is displayed (without the non-printing characters of the markdown syntax or ASCII Doc syntax). To return to the textbox, simply click the Edit button and continue typing.

  5. Click Save.

If your package is based on material imported from GitHub, you have the option to import the readme from GitHub as well. Note that only a readme file (a specific file, readme.me, defined as the readme file in GitHub) can be imported from GitHub and properly displayed on Bintray.

Adding Release Notes to Packages and/or Versions

You can add release notes to a package you own or to some or all of its versions separately.

Release Notes may be package-level or version-level. Having package-level release notes means that the same release notes apply to (and are displayed in the pages of) the package and all its versions. Having version-level release notes means that each version can have its own release notes (displayed in the Release Notes tab of the Version page) and the Release Notes tab of the Package page displays the release notes of all the versions that have published files, divided into sections.

Package-level and version-level release notes are mutually-exclusive. If a package has version-level release notes, creating package-level release notes will override the version-level release notes. If a package has package-level release notes, these release notes must be deleted before version-level release notes can be added.

There are two ways to create release notes: add/edit text in the Bintray UI (this text can be Markdown, ASCII Doc or plain text) or import release notes from Bintray for a package or for a version.

To add package-level release notes to a package:

  1. On the relevant Package page, select the Release Notes tab.

  2. From the drop-down menu of the Use release notes from field, select Bintray (if not already selected by default).

  3. To set the package to package-level release notes, click the Own Package-Level Release Notes link.

    Own Pckg-lvl RN (RN tab, Pckg)

  4. In the text box that opens, select the text syntax format you want to use.
    The options are: Markdown, ASCII Doc and Plain Text.

    Note: click here for full information about how to use markdown syntax; click here for full information about how to use ASCII Doc or just use plain text.

    Syntax (RN tab, Pckg)

  5. In the text box, type the text of the release notes for the package.

    Note: while typing, at any time, click the Preview button to see what the text will look like when it is displayed (without the non-printing characters of the markdown syntax or ASCII Doc syntax). To return to the textbox, simply click the Edit button and continue typing.

  6. Click Save.

To delete package-level release notes (to enable version-level release notes):

  1. Access the relevant Version page and select the Release Notes tab.

    In the Release Notes tab of a Version page in a package that has package-level release notes, the package-level release notes are displayed, along with a message that version-level release notes are disabled:

  2. Click the Package Release Notes link.

    Package Rel Notes (RN tab, Ver)
    Alternatively, you can just access the Release Notes tab of the Package page, since this is where this link takes you.

  3. In the Release Notes tab of the Package page, click Delete, and then click OK in the confirmation message that appears.

    Delete Pckg Release Notes
    The package-level release notes are deleted and version-level release notes are enabled.

To add version-level release notes to a version (when no package-level release notes exist):

  1. Access the relevant Version page and select the Release Notes tab.

  2. From the drop-down menu of the Use release notes from field, select Bintray (if not already selected by default) and then click Edit.

    Use RN from (RN tab, Ver)

  3. In the text box that opens, select which text format you want to use from the Syntax drop-down menu.

    The options are: Markdown, ASCII Doc and Plain Text.

    Note: click here for full information about how to use markdown syntax; click here for full information about how to use ASCII Doc or just use plain text.

    Syntax (RN tab, Ver)

  4. In the text box, type the text of the release notes for the version.

    Note: while typing, you can click the Preview button at any time to see what the text will look like when it is displayed (without the non-printing characters of the markdown syntax or ASCII Doc syntax). To return to the textbox, simply click the Edit button and continue typing.

  5. Click Save.

If your package is based on material imported from GitHub, you have the option to import the release notes from GitHub to a Bintray package or to a Bintray version. Note that only markdown, ASCII Doc or plain text release notes files can be imported from GitHub and properly displayed on Bintray.

Creating and Editing a Download List

The download list is a feature of Bintray packages and versions in which the user who owns the package or version can list a few select files as a recommended list for download or a shortcut list for downloading the newest, most important or most popular files from within his or her package or version.

It is a very simple process for another user to download from the download list.

To mark a file for inclusion in the download list:

  1. Access the Version page of the version that contains the file (it must be a version you own or, if the version is within a repository belonging to an organization, you must have the relevant authorization).

  2. Select the Files tab.

  3. Hover over the Actions icon of the relevant file.

    From the drop-down list that opens, select the Show in download list option.

    Upon selection of this option, an icon appears next to the file name indicating this file is on the download list.

The files are also listed in the download list of the version.

Download list in Version page

If a description has been added to any of the files in the download list, it will appear under the file name.

If this is the newest version within the package that has any files included in the download list, these file are also included in the download list of the package.

GPG Signing

GPG signing is an optional feature of Bintray that allows the publisher of uploaded material to sign it so it can be verified as authentic and original by the users.

A key pair is entered into your profile on Bintray (this key pair can be specific for Bintray). The public key is available to all Bintray users who view your profile; your private key is encrypted and kept safe. Your private key is supplied when you upload; your public key is then used by the users to verify that the uploaded material is indeed yours. As a further measure of security, it is possible (but optional) to passphrase-protect your private key by using the relevant REST-API command (and then provide the passphrase when you sign in).

Entering a GPG key pair (for a user) is done in the GPG Signing form of the Edit Your Profile page; for an organization, it is done in the GPG Signing form of the Edit Organization page.

If you prefer, you may skip entering your GPG key pair, and instead, use Bintray’s internal key to sign uploaded packages.

Signing Repository Files Automatically With Your Uploaded Key or with the Bintray Key

Access the relevant Repository page and click the Edit button to display the Edit Repository page.
Sign Option (Repo Details)

Signing With Your Own Key

To sign packages using your own GPG key, check the GPG Sign uploaded files automatically checkbox.
Note that this checkbox is only available if you have a entered a valid GPG Key Pair.
You can also sign a repository with your key using REST-API commands (click here for full information about the REST API commands).

Signing with the Bintray Key

If you prefer to sign packages using Bintray’s internal key, check the GPG sign uploaded files using Bintray’s public/private key pair checkbox.

The following is the Bintray’s public key information:
pub 4096R/D401AB61 2015-02-17
uid Bintray (by JFrog) <bintray@bintray.com>
sub 4096R/DBE1D0A2 2015-02-17

These two checkboxes are mutually exclusive. You can select either one or the other, or neither of them if you do not want to sign packages you upload. Once one of the signing options is selected in the repository profile, all uploads to this repository will be signed, whether by REST commands, or using the UI. If you are signing uploaded material using a REST command, and passing a GPG key, the passed key pair will override the GPG key that is stored in the repository profile (either your own key or Bintray’s key).

Merging Packages

For better management of your material, Bintray allows you to 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 (the package into which the others are merged). The files within the versions of these packages are all kept.

Only packages within the same repository may be merged together.

The versions of the different packages are also consolidated: the merged package includes all the versions with different names that were included in all the original packages. If different packages had versions with the same name, those versions will be unified. The unified version will keep the files from all its component versions. Its metadata will be taken from one of the packages (if one of the packages that has versions of the same name is the source package, the metadata will be taken from the same-name version of the source package).

The merged package inherits the following metadata elements from the source package:

Note that the metadata (including attributes and screenshots and also including ratings and reviews) of the packages merged into the source package are lost.

The download list of the of all three packages are consolidated into one download list (note that the download list is the only package metadata that remains from the packages that were merged into the source package).

The versions that are not unified with other versions of the same name retain their own version metadata, except that which they inherited from their packages.

To merge packages:

  1. Access the Package page of the source package and click the Merge button to display the Select Package form.
    Note that in the Select Package form, the source package is displayed on the right side and all other packages in the same repository (the packages that may be selected for the merge) are displayed on the left.

  2. In the Select Package form, click the check mark next to each package to be included in the merge. This will move it from the left column to the right (included) column.
    To undo the selection to include, you can click the cross next to the included package.

  3. While doing the merge, you can even click the package name and change it to reflect the merge if you wish (optional).

    Select Package form

  4. Once you have selected all the packages that should be merged, and finalized the merged package name, click the green Merge button. Since merge is an irreversible operation, you will be presented with a confirmation dialog. If you are sure you want to continue, click Merge again.

Deleting Content

If you are a logged-in user of Bintray, you can delete all the material you own including files you have uploaded, your packages versions, and packages and repos that you own. You can even delete your entire Bintray account.

Deleting a specific file can be done only during the first 24 hours since its publication. This is a grace period allowing the uploading user to change his or her mind if a major problem is discovered after its publication. Note, of course, that this grace period is an additional one after the time passing from the file’s upload to its publication.

An important note about deleting any material:
_ Any package, version or file you have published may now be an integral part of someone else’s project and deleteting them may damage their work (deleting unpublished files is not a problem since they are not visible to anyone else)._

Note: if a package of yours has been linked to someone else’s repository and you then delete the package, Bintray will automatically create a copy of this package in the repository. This means that even though you deleted the data, the data still exists in another version somewhere.

To delete a specific file:
Note that you can only delete a file in the first 24 hours since it was uploaded.

  1. Access the Version page to which the file has been uploaded.

  2. Select the Files tab.

  3. Hover over the Actions icon of the relevant file.

    Action button (Files tab, Ver.)

  4. From the drop-down list that opens, select the Delete option.

    The file is deleted without further confirmation.

To delete versions, packages or repositories:

  1. Access the page of the version, package or repository you want to delete. It must be a version of a package that you own or a package or repository that you own.

  2. Click the Edit button under the name of the version, package or repo.
    The Edit Version / Edit Package / Edit Repository page opens.

  3. Scroll down to the bottom of the Edit page and click the red Delete button.
    Since deletion is irreversible, a dialog will be displayed prompting you to confirm. Click Delete to complete the action.

To delete your Bintray account:

  1. Access your user profile by clicking your gravatar or user name in the ribbon at the top of the screen.

  2. Click the Edit button under your username to display the Edit Your Profile page and scroll down to the bottom.

  3. Click the red Delete Account button.
    Since deleting your account is irreversible, a dialog will be displayed prompting you to confirm.

  4. To confirm, click Delete Account.