Page Contents

Overview

You can import and display readme files and release notes from GitHub to Bintray in the following formats: plain text, markdown text or ASCII Doc text. The files are displayed in the Readme or Release Notes tabs of the relevant package or version.

Importing Readme Texts from GitHub to a Bintray Package or Version

Release notes, readme files and other text files (plain text, markdown text or ASCII Doc text) are imported into Bintray from the GitHub repository (not from a release, or tag). These files may still refer to a specific release or tag, and can therefore still be used as release notes or readme files in Bintray versions, and not just the Bintray package that corresponds to the GitHub repository. In order to import a readme file into Bintray from GitHub the filename must be: readme.md.

Readme file in GitHub

Readme files are imported as markdown, ASCII Doc or plain text, and are displayed in the Bintray UI, in the Readme tab of the relevant package or version.

To import a readme file from GitHub for a package or version in Bintray you need to:

  • Authorize Bintray to import from your GitHub account.

  • Specify a repository in GitHub from which the readme text should be imported.

Here are the steps you need to take to set this up:

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

  2. From the drop-down menu of the Using readme file from field, select the GitHub file option.

    Use readme from (Readme, Pckg)
    If Bintray is not yet authorized to access your GitHub account, or you have not yet specified a repository from which readme files should be imported, Bintray displays the following message with corresponding links to help you complete the process.

    Use GitHub file (Readme tab, Pckg)

  3. If necessary, click the GitHub username link to authorize Bintray to import from GitHub and/or the GitHub user/repo link to define a repository in GitHub from which to import the readme file.

  4. If necessary, access the Readme tab of the Package or Version page again, and select the GitHub file option in the Using readme file from field.

    The readme file from GitHub is displayed.

    Readme tab: imported text (Pckg)

Importing Release Notes from GitHub to a Bintray Package

Bintray can import release notes from GitHub for use with a Bintray package. The release notes must be stored in GitHub at the repository level (not in a release or tag).

Release Notes file in GitHub

Release notes are imported into Bintray as markdown text and are displayed in the Bintray UI, in the Release Notes tab of the relevant package.

To import a release note from GitHub for a package in Bintray you need to:

  • Authorize Bintray to import from your GitHub account.

  • Specify a repository in GitHub from which the release notes should be imported

  • Specify the name of the release notes file

Here are the steps you need to take to set this up:

  1. Access the relevant Package page and select its Release Notes tab.

  2. From the drop-down menu of the Using release notes from field, select the GitHub File option.

    Use release notes from

    If any of the above steps have not been completed, Bintray will display the following message with corresponding links to help you.

    Use GitHub file (RN tab, Pckg)

  3. If your Bintray account is not yet authorized to access your GitHub account, click the GitHub username link. This will direct you to the Accounts form of the Edit Your Profile page, through which you can set up the relevant authorization.

  4. Next, click the GitHub user/repo link or the GitHub release notes file link to display the Edit Package page.

  5. In the GitHub Repo field, enter your GitHub username and the name of the repository from which you want to import the release notes using the following format: Github user/repo.

    GitHub Repo (Edit Package)

  6. Next, click Update Package in order to save this setting.

    The Edit Package page is refreshed and the GitHub release notes file field becomes enabled.

  7. Enter the file name of the release note.

    GitHub RN file (Edit Package)

  8. Click Update package again.

  9. If you now go back to the Release Notes tab of the Package page and select the GitHub File option for Use release notes from field, the release notes from GitHub are displayed.

    Imported text (RN tab, Pckg)

Importing Release Notes from GitHub to a Bintray Version

Bintray is able to import release notes and tag descriptions from GitHub.

Release notes are files stored in GitHub directly under the repository (not in a release or tag).

Release Notes file in GitHub

These release notes files are imported into Bintray and are displayed in the Release Notes tab of the Package page and of the Version page of each version in the package.

Tag descriptions are edited in GitHub as the tag is released or drafted.

Tag description in GitHub

These tag descriptions are imported into Bintray and are displayed in the Release Notes tabs of the relevant Version pages (one tag description per version).

To display GitHub content as release notes of Bintray versions, you can either import a GitHub release notes file or import tag descriptions (but you cannot import both).

In order to import release notes from GitHub for a version in Bintray, you first need to ensure that Bintray is properly set up to access your GitHub account as follows:

  • Authorize Bintray to import from your GitHub account.

  • Specify a repository in GitHub from which the release notes should be imported

  • Specify the name of the release notes file

To import a release notes file from GitHub to a version in Bintray:

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

  2. From the drop-down menu of the Use release notes file from field, select the GitHub file option.

    Use RN from (RN tab, Ver)

    If Bintray is not yet authorized to access your GitHub account, or you have not yet specified a repository from which release notes should be imported, Bintray will display the following message with corresponding links to help you.

    Use GitHub file (RN tab, Ver)

  3. If necessary, click the relevant link to authorize Bintray to import from GitHub and/or define a repository in GitHub from which to import the release notes file, and/or define the release notes file itself.

    After clicking the GitHub Release Notes link, the Edit Version page is displayed, showing its Version Details form.
    If you have not yet specified a repository in GitHub from which to import the release notes text, click the GitHub User/repo link, which will direct you to the Edit Package page where you can do so.

    Please Config…​(Edit Version)

  4. Back in the Version Details form, in the GitHub release notes file field, enter the path and filename of the release notes file you want associated with this Bintray version (it does not necessarily have to be the release notes of the GitHub release from which this Bintray version has been imported).

    GitHub RN file (Edit Version)

  5. Click Save Changes.

  6. Access the Release Notes tab of the Version page again and select the option GitHub File, in the Using release notes from drop-down list.

    The release notes file from GitHub is displayed.

    Imported text (RN tab, Ver.)

To import a tag description from GitHub to a version in Bintray:

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

  2. Select the GitHub releases option in the Using release notes file from drop-down list.

    Use RN from (RN tab, Ver)

    If Bintray is not yet authorized to access your GitHub account, or you have not yet specified a repository from which release notes should be imported, Bintray will display the following message with corresponding links to help you.

    Use GitHub Releases (RN tab, Ver)

  3. If necessary, click the GitHub username link to authorize Bintray to import from GitHub, and/or the GitHub User/Repo link to define a repository from which to import the tag description.

  4. To specify the tag from which to import the description, click the VCS Tag link to display the Edit Version page showing its Version Details form.

    Note: If near the GitHub release notes file field you see a notification saying Please Configure the Package GitHub user/repo, this means a GitHub repository has not been assigned for this package for the purpose of release notes, which applies to both release notes files and tag descriptions. You can click the GitHub user/repo link which will direct you to the Edit Package page where you can assign a reference to the relevant repository in GitHub.

    Please Config…​(Edit Version)

  5. Return to the Version Details form of the Edit Version page, and in the VCS tag field, enter the tag name you want associated with this Bintray version. Next, click Update version (Note that the VCS tag must be in the repository defined in the GitHub user/repo field in the Edit Package page).

    Choose Git Tag (Ver Dtls, Ed. Ver)

  6. Click Save Changes.

  7. Go back to the Release Notes tab of the Version page and again, select the GitHub releases option in the Use release notes from field.

    The release notes from GitHub tag are displayed.

    Imported Tag Desc (RN tab, Ver.)