Jenkinsfile

// Copyright 2022 Mycroft AI Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
// -----------------------------------------------------------------------------
//
// Jenkins pipeline for building Mimic 3 artifacts.
//
// Requires Docker buildx: https://docs.docker.com/buildx/working-with-buildx/
// Assumes the en_UK/apope_low voice is in /home/jenkins/.local/share/mycroft/mimic3/voices

pipeline {
    agent any

    environment {
        // Adds GITHUB_USR and GITHUB_PSW environment variables
        GITHUB = credentials('devops-mycroft')

        // Adds PYPI_USR and PYPI_PSW environment variables
        PYPI = credentials('pypi-mycroft')

        // Adds DOCKER_USR and DOCKER_PSW environment variables
        DOCKER = credentials('dockerhub-mycroft')

        DOCKER_BUILDKIT = '1'
        DOCKER_PLATFORM = 'linux/amd64,linux/arm64,linux/arm/v7'
        DOCKER_TAG = 'mycroftai/mimic3'

        DEFAULT_VOICE = 'en_UK/apope_low'
        DEFAULT_VOICE_PATH = '/home/jenkins/.local/share/mycroft/mimic3/voices'

        GITHUB_OWNER = 'mycroftAI'
    }

    stages {
        // Clean up
        stage('Clean') {
            steps {
                sh 'rm -rf dist/ voices/ plugin-tts-mimic3/dist/'
            }
        }

        // Clone the source code from Github
        stage('Clone') {
            steps {
                git branch: 'master',
                    credentialsId: 'devops-mycroft',
                    url: 'https://github.com/mycroftAI/mimic3.git'


                // Mycroft TTS plugin
                dir('plugin-tts-mimic3') {
                    git branch: 'master',
                        credentialsId: 'devops-mycroft',
                        url: 'https://github.com/mycroftAI/plugin-tts-mimic3'
                }

                script {
                    // Get individual tags
                    env.MIMIC3_TAG_NAME = sh(
                        returnStdout:  true,
                        script: "git tag --contains | head -n 1"
                    ).trim()

                    dir('plugin-tts-mimic3') {
                        env.PLUGIN_TAG_NAME = sh(
                            returnStdout:  true,
                            script: "git tag --contains | head -n 1"
                        ).trim()
                    }
                }

                echo "Mimic 3 tag: ${env.MIMIC3_TAG_NAME}"
                echo "Plugin tag: ${env.PLUGIN_TAG_NAME}"
            }
        }

        // Copy default voice
        stage('Copy voices') {
            steps {
                sh 'mkdir -p voices/${DEFAULT_VOICE}'
                sh 'rsync -r --link-dest="${DEFAULT_VOICE_PATH}/${DEFAULT_VOICE}/" "${DEFAULT_VOICE_PATH}/${DEFAULT_VOICE}/" voices/${DEFAULT_VOICE}/'
            }
        }

        // Build, test, and publish plugin distribution package to PyPI
        stage('Plugin dist') {
            steps {
                sh 'make plugin-dist'
            }
        }

        // Create a new tagged Github release with source distribution for Mycroft plugin
        stage('Publish plugin') {
            environment {
                GITHUB_REPO = 'plugin-tts-mimic3'
                PLUGIN_VERSION = readFile(file: 'plugin-tts-mimic3/mycroft_plugin_tts_mimic3/VERSION').trim()
                PLUGIN_TAG_NAME = "${env.PLUGIN_TAG_NAME}"
            }

            when {
                expression {
                    return env.PLUGIN_TAG_NAME.startsWith('release/')
                }
            }

            steps {
                // Publish to PyPI
                sh 'twine upload --skip-existing --user __token__ --password "${PYPI_PSW}" dist/mycroft_plugin_tts_mimic3-${PLUGIN_VERSION}.tar.gz'

                // Delete release for tag, if it exists
                sh 'scripts/delete-tagged-release.sh ${GITHUB_OWNER} ${GITHUB_REPO} ${PLUGIN_TAG_NAME} ${GITHUB_PSW}'

                // Create new tagged release and upload assets
                sh 'scripts/create-tagged-release.sh ${GITHUB_OWNER} ${GITHUB_REPO} ${PLUGIN_TAG_NAME} ${GITHUB_PSW}' +
                   ' dist/mycroft_plugin_tts_mimic3-${PLUGIN_VERSION}.tar.gz application/gzip'

                echo 'Published plugin PyPI and Github release'
            }
        }

        // Build, test, and publish source distribution packages to PyPI
        stage('Dist') {
            steps {
                sh 'make dist'
            }
        }

        // Build and publish Debian packages to Github
        stage('Debian') {
            steps {
                sh 'make debian'
            }
        }

        // Create a new tagged Github release with source distribution and Debian packages
        stage('Publish mimic3') {
            environment {
                MIMIC3_VERSION = readFile(file: 'mimic3_tts/VERSION').trim()
                GITHUB_REPO = 'mimic3'
            }

            when {
                expression {
                    return env.MIMIC3_TAG_NAME.startsWith('release/')
                }
            }

            steps {
                // Publish to PyPI
                sh 'twine upload --skip-existing --user __token__ --password "${PYPI_PSW}" dist/linux_amd64/mycroft_mimic3_tts-${MIMIC3_VERSION}.tar.gz'

                // Delete release for tag, if it exists
                sh 'scripts/delete-tagged-release.sh ${GITHUB_OWNER} ${GITHUB_REPO} ${MIMIC3_TAG_NAME} ${GITHUB_PSW}'

                // Create new tagged release and upload assets
                sh 'scripts/create-tagged-release.sh ${GITHUB_OWNER} ${GITHUB_REPO} ${MIMIC3_TAG_NAME} ${GITHUB_PSW}' +
                    ' dist/linux_amd64/mycroft_mimic3_tts-${MIMIC3_VERSION}.tar.gz application/gzip' +
                    ' dist/linux_amd64/mycroft-mimic3-tts_${MIMIC3_VERSION}_amd64.deb application/vnd.debian.binary-package' +
                    ' dist/linux_arm64/mycroft-mimic3-tts_${MIMIC3_VERSION}_arm64.deb application/vnd.debian.binary-package' +
                    ' dist/linux_arm_v7/mycroft-mimic3-tts_${MIMIC3_VERSION}_armhf.deb application/vnd.debian.binary-package'

                echo 'Published Mimic 3 PyPI and Github release'
            }
        }

        // Build and publish multi-platform Docker image to Dockerhub
        stage('Docker') {
            steps {
                sh 'make docker'
            }
        }

        // Publish Docker image to DockerHub
        stage('Publish docker') {
            environment {
                MIMIC3_VERSION = readFile(file: 'mimic3_tts/VERSION').trim()
                DOCKER_TAG = "mycroftai/mimic3:latest,mycroftai/mimic3:${env.MIMIC3_VERSION}"
                DOCKER_OUTPUT = '--push'
            }

            when {
                expression {
                    return env.MIMIC3_TAG_NAME.startsWith('release/')
                }
            }

            steps {
                // Publish to DockerHub
                sh 'docker login --username "${DOCKER_USR}" --password "${DOCKER_PSW}"'
                sh 'make docker'
                echo 'Published docker image'
            }
        }

    }
}