Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 4.74 KB

SUBMIT.md

File metadata and controls

130 lines (93 loc) · 4.74 KB

DevOps your Skill: Submit

This is the last step of our pipeline. Previously we have run a lot of different tests and if everything is ok, it is time to submit our Alexa Skill to certification. It means, we have concluded the Continuous integration part, it is time to Continuous Deployment.

These step are automated in the continuous integration system (GitHub Actions) and are executed in each new version of the software.

Prerequisites

Here you have the technologies used in this project

  1. ASK CLI - Install and configure ASK CLI
  2. GitHub Account - Sign up here
  3. Node.js v10.x
  4. Visual Studio Code

ASK CLI (Alexa Skill Kit CLI)

The Alexa Skills Kit Command Line Interface (ASK CLI) is a tool for you to manage your Alexa skills and related resources, such as AWS Lambda functions. With ASK CLI, you have access to the Skill Management API, which allows you to manage Alexa skills programmatically from the command line. We will use this powerful tool to validate our Alexa Skill. Let's start!

Installation

We need to install the ASK CLI or use it as it is included in the Docker image and the GitHub Action.

Submit

In this step of the pipeline we are going to submit our Alexa Skill using the ASK CLI. When you submit your skill to the Alexa Store, it must pass a certification process from Amazon staff before it can be published live to Amazon customers. We can use the following commands in the Skill Management API (SMAPI) to manage the certification and publication of an Alexa skill. In our case, we will only submit to certificate and not publishing it automatically, just certify.

  1. For ask cli v1:
    ask api submit -s ${skill_id} --publication-method MANUAL_PUBLISHING
  1. For ask cli v2:
    ask smapi submit-skill-for-certification -s ${skill_id} --publication-method MANUAL_PUBLISHING

Those commands are integrated in the bash script file test/submit/submit.sh.

Here you can find the full bash script:

    #!/bin/bash
    skill_id=$1

    cli_version=$2

    echo "######### Submiting Skill for certification without publishing #########"

    if [[ ${cli_version} == *"v1"* ]]
    then
        submit=$(ask api submit -s ${skill_id} --publication-method MANUAL_PUBLISHING)
        exit 0
    else
        submit=$(ask smapi submit-skill-for-certification -s ${skill_id} --publication-method MANUAL_PUBLISHING)
        exit 0
    fi

This script has two parameters:

  1. The id of the skill
  2. The version of the ASK CLI you are running (v1 or v2).

Reports

There are not reports defined in this job.

But we can see in the Alexa Developer Console the new status of our Alexa Skill in the Certification tab:

image

Integration

It is not necessary to integrate it in package.json file.

Pipeline Job

Everything is ready to submit our Alexa Skill, let's add it to our pipeline!

This job will execute the following tasks:

  1. Checkout the code
  2. Run the submit script.
  submit:
    runs-on: ubuntu-latest
    name: Submit
    needs: validation-test
    steps:
    # To use this repository's private action,
    # you must check out the repository
    - name: Checkout
      uses: actions/checkout@v2
    - run: |
        sudo npm install -g ask-cli;
        chmod +x -R ./test;
        cd test/submit/;
        ./submit.sh $SKILL_ID v2
      env: # Or as an environment variable
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        ASK_ACCESS_TOKEN: ${{ secrets.ASK_ACCESS_TOKEN }}
        ASK_REFRESH_TOKEN: ${{ secrets.ASK_REFRESH_TOKEN }}
        ASK_VENDOR_ID: ${{ secrets.ASK_VENDOR_ID }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        SKILL_ID: ${{ secrets.SKILL_ID }}

NOTE: To perform these tests in GitHub Actions you have to set the secret SKILL_ID with the id of your Alexa Skill.

Resources

Conclusion

Thanks to the ASK CLI we can perform this complex task. This is the end, thank you for reading it until here!

I hope this example project is useful to you.

That's all folks!

Happy coding!