Azure-Samples / LUIS-DevOps-Template

Template repo encapsulating best engineering practices and DevOps using GitHub Actions for the development of a LUIS application.
MIT License
21 stars 17 forks source link

page_type: sample languages:

Developing a LUIS app using DevOps practices

Flask sample MIT license badge

Preview

LUIS-DevOps-Template is currently under public preview and is not ready for production use.

Use this repository to develop a LUIS application while following DevOps engineering practices that adhere to software engineering fundamentals around source control, testing, CI/CD and release management. This template repository provides a working project structure and GitHub Actions pipelines that you can customize for use with your own project.

You can find out more about LUIS in the Language Understanding (LUIS) documentation.

Important: This repo is built to be used as a template to create your own repo. Please ensure that you review the project setup instructions for the correct instructions on how to use this template before you decide to fork or clone.

Contents

File/folder Description
.github\workflows Sample GitHub Actions pipeline.
.gitignore Define what to ignore at commit time.
azuredeploy.json ARM template used by Deploy to Azure.
CHANGELOG.md List of changes to the sample.
CONTRIBUTING.md Guidelines for contributing to the sample.
docs Documentation
luis-app Sample LUIS app and test files
setup Setup scripts
README.md This README file.
LICENSE The license for the sample.

Prerequisites

How to use this template repository

Follow these steps to setup your own copy of this repository in your personal GitHub account:

  1. Follow the Project setup instructions to clone this template repository to your own GitHub account and to configure it for use.
  2. Follow the Making updates to a LUIS app in a feature branch tutorial to understand the "dev inner loop" workflow for making updates to the LUIS app while using DevOps practices.
  3. This template repository uses a sample LUIS project vacation_requests, defined in this repo in the model.lu file. To use this repository with your own project, follow these instructions: Customizing the repository for your own project.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.