Skip to content

Latest commit

 

History

History
139 lines (125 loc) · 4.85 KB

Readme.md

File metadata and controls

139 lines (125 loc) · 4.85 KB
Raw

Kodi Addon Submitter

This is a command line script for automating submission of addons for Kodi Mediacenter to the official addon repository. The utility automates the steps for preparing and creating addon submission pull requests to one of the addon repositories: xbmc/repo-plugins or xbmc/repo-scripts. It is meant for using primarily in CI/CD pipelines, e.g. in Travis CI.

The script is compatible with Python 2.7 and 3+.

Prerequisites

  • Your addon files must have one of the following formats
    • Your addon files must be located in the root directory inside your Git repository. That is, your Git repo for the addon must have the following layout: 
      /<git-repo-directory>/
|
|
+--/resources/
|  |
|  ...
+--addon.xml
+--fanart.jpg
+--icon.png
|
+--.gitignore
+--.travis.yml
+--Readme.md
      To not pollute your addon submission with unnecessary files, such as .gitignore, .travis.yml etc. those can be exluded by using git-archive and setting the [export-ignore attribute] (https://git-scm.com/docs/gitattributes#_creating_an_archive).
    • Your addon files must be located in a separate addon directory, e.g. /plugin.video.example inside your Git repository. That is, your Git repo for the addon must have the following layout: 
      /<git-repo-directory>/
|
+--/plugin.video.example/
|  |
|  +--/resources/
|  |  |
|  |  ...
|  +--addon.xml
|  +--fanart.jpg
|  +--icon.png
|
+--.gitignore
+--.travis.yml
+--Readme.md
  • Fork the necessary addon repository -- xbmc/repo-plugins or xbmc/repo-scripts -- into your GitHub account.
  • Define the following environment variables in your CI environment:
    • GH_USERNAME: your GitHub username.
    • GH_TOKEN: your GitHub access token with at least public_repo scope.
    • EMAIL: your email
  • It is strongly recommended to have <news> section in your addon.xml that describes the changes made in the latest version being submitted. The contents of the <news> tag will be automatically added to a pull request message.

Installation

The Addon Submitter utility is installed from this repository with pip:

pip install git+https://github.com/romanvm/kodi-addon-submitter.git

Usage

Run submit-addon script with the following options:

  • addon_id (positional): your addon ID, e.g. plugin.video.example.
  • -z, --zip (optional): create a versioned installable ZIP for the addon. It can be used, e.g, if you are deploying your addon to GitHub Releases.
  • -r, --repo: addon repo, e.g. repo-plugins or repo-scripts.
  • -b, --branch: addon repo branch, that corresponds to a Kodi version codename, e.g. krypton or leia.
  • --push-branch: create an addon branch in your repo fork.
  • --pull-request: create a pull request for the addon submission in the Kodi repository. With this option the script will create/update an addon branch, as with --push-branch option, and then create a pull request in the respective official Kodi addon repository, if it does not exist. If the pull request already exists, the script will simply update the addon branch in your repository fork.
  • -s, --subdirectory: Addon is stored in its own directory within the git repo
  • -m, --matrix: Submit a Python 2/3 compatible addon to matrix branch in addition to the target branch. This can be used if you want to update a Python 2/3 compatible addon both in matrix (Kodi 19.x) and a lower branch at the same time. Do not use this option if you want to submit a Python 3 addon only to matrix branch. Use -b option for this.

Example:

submit-addon -r repo-plugins -b leia --pull-request plugin.video.example

Example Travis CI Configuration

language: python
python: "3.6"
install: echo "Install test dependencies"
script: echo "Run tests"
before_deploy:
  - pip install git+https://github.com/romanvm/kodi-addon-submitter.git
  - submit-addon -z plugin.video.example # Create an installable ZIP
  - export RELEASE_ZIP=$(ls *.zip)
deploy:
  # Publish an installable ZIP to GitHub Releases
  - provider: releases
    api_key: $GH_TOKEN
    file_glob: true
    file: $RELEASE_ZIP
    skip_cleanup: true
    on:
      tags: true
  # Submit to the official Kodi repo
  - provider: script
    script: submit-addon -r repo-plugins -b leia --pull-request plugin.video.example
    on:
      tags: true
notifications:
  email: false

This config automatically publish your addon to "Releases" section of your addon repository and creates a pull request in the official Kodi addon repository when a new git tag is pushed to your addon repository. So with this config simply run

git tag <version number>
git push --tags

to submit your addon. Everything else will be done automatically by Travis CI.