Package: rasa
Rasa Open Source💡We're migrating issues to Jira💡Starting January 2023, issues for Rasa Open Source are located inthis Jira board. You can browse issues without being logged in;
if you want to create issues, you'll need to create a Jira account.Rasa is an open source machine learning framework to automate text and voice-based conversations. With Rasa, you can build contextual assistants on:Facebook MessengerSlackGoogle HangoutsWebex TeamsMicrosoft Bot FrameworkRocket.ChatMattermostTelegramTwilioYour own custom conversational channelsor voice assistants as:Alexa SkillsGoogle Home ActionsRasa helps you build contextual assistants capable of having layered conversations with
lots of back-and-forth. In order for a human to have a meaningful exchange with a contextual
assistant, the assistant needs to be able to use context to build on things that were previously
discussed – Rasa enables you to build assistants that can do this in a scalable way.There's a lot more background information in thisblog post.🤔Learn more about Rasa🤓Read The Docs😁Install Rasa🚀Dive deeper in the learning center🤗Contribute❓Get enterprise-grade support🏢Explore the features of our commercial platform📚Learn more about research papers that leverage RasaWhere to get helpThere is extensive documentation in theRasa Docs.
Make sure to select the correct version so you are looking at
the docs for the version you installed.Please useRasa Community Forumfor quick answers to
questions.README Contents:How to contributeDevelopment InternalsReleasesLicenseHow to contributeWe are very happy to receive and merge your contributions into this repository!To contribute via pull request, follow these steps:Create an issue describing the feature you want to work on (or
have a look at thecontributor board)Write your code, tests and documentation, and format them withblackCreate a pull request describing your changesFor more detailed instructions on how to contribute code, check out thesecode contributor guidelines.You can find more information about how to contribute to Rasa (in lots of
different ways!)on our website..Your pull request will be reviewed by a maintainer, who will get
back to you about any necessary changes or questions. You will
also be asked to sign aContributor License Agreement.Development InternalsInstalling PoetryRasa uses Poetry for packaging and dependency management. If you want to build it from source,
you have to install Poetry first. Please followthe official guideto see all possible options.To update an existing poetry version to theversion, currently used in rasa, run:poetryselfupdate<version>Managing environmentsThe officialPoetry guidesuggests to usepyenvor any other similar tool to easily switch between Python versions.
This is how it can be done:pyenvinstall3.10.10
pyenvlocal3.10.10# Activate Python 3.10.10 for the current projectNote: If you have trouble installing a specific version of python on your system
it might be worth trying other supported versions.By default, Poetry will try to use the currently activated Python version to create the virtual environment
for the current project automatically. You can also create and activate a virtual environment manually — in this
case, Poetry should pick it up and use it to install the dependencies. For example:python-mvenv.venvsource.venv/bin/activateYou can make sure that the environment is picked up by executingpoetryenvinfoBuilding from sourceTo install dependencies andrasaitself in editable mode executemakeinstallNote for macOS users: under macOS Big Sur we've seen some compiler issues for
dependencies. Usingexport SYSTEM_VERSION_COMPAT=1before the installation helped.Installing optional dependenciesIn order to install rasa's optional dependencies, you need to run:makeinstall-fullNote for macOS users: The commandmake install-fullcould result in a failure while installingtokenizers(issue described in depthhere).In order to resolve it, you must follow these steps to install a Rust compiler:brewinstallrustup
rustup-initAfter initialising the Rust compiler, you should restart the console and check its installation:rustc--versionIn case the PATH variable had not been automatically setup, run:exportPATH="$HOME/.cargo/bin:$PATH"Running and changing the documentationFirst of all, install all the required dependencies:makeinstallinstall-docsAfter the installation has finished, you can run and view the documentation
locally using:makelivedocsIt should open a new tab with the local version of the docs in your browser;
if not, visithttp://localhost:3000in your browser.
You can now change the docs locally and the web page will automatically reload
and apply your changes.Running the TestsIn order to run the tests, make sure that you have the development requirements installed:makeprepare-tests-ubuntu# Only on Ubuntu and Debian based systemsmakeprepare-tests-macos# Only on macOSThen, run the tests:maketestThey can also be run at multiple jobs to save some time:JOBS=[n]maketestWhere[n]is the number of jobs desired. If omitted,[n]will be automatically chosen by pytest.Running the Integration TestsIn order to run the integration tests, make sure that you have the development requirements installed:makeprepare-tests-ubuntu# Only on Ubuntu and Debian based systemsmakeprepare-tests-macos# Only on macOSThen, you'll need to start services with the following command which usesDocker Compose:makerun-integration-containersFinally, you can run the integration tests like this:maketest-integrationResolving merge conflictsPoetry doesn't include any solution that can help to resolve merge conflicts in
the lock filepoetry.lockby default.
However, there is a great tool calledpoetry-merge-lock.
Here is how you can install it:pipinstallpoetry-merge-lockJust execute this command to resolve merge conflicts inpoetry.lockautomatically:poetry-merge-lockBuild a Docker image locallyIn order to build a Docker image on your local machine execute the following command:makebuild-dockerThe Docker image is available on your local machine asrasa:localdev.Code StyleTo ensure a standardized code style we use the formatterblack.
To ensure our type annotations are correct we use the type checkerpytype.
If your code is not formatted properly or doesn't type check, GitHub will fail to build.FormattingIf you want to automatically format your code on every commit, you can usepre-commit.
Just install it viapip install pre-commitand executepre-commit installin the root folder.
This will add a hook to the repository, which reformats files on every commit.If you want to set it up manually, install black viapoetry install.
To reformat files executemake formatterType CheckingIf you want to check types on the codebase, installmypyusingpoetry install.
To check the types executemake typesDeploying documentation updatesWe useDocusaurus v2to build docs for tagged versions and for themainbranch.
To run Docusaurus, installNode.js 12.x.
The static site that gets built is pushed to thedocumentationbranch of this repo.We host the site on netlify. Onmainbranch builds (see.github/workflows/documentation.yml), we push the built docs to
thedocumentationbranch. Netlify automatically re-deploys the docs pages whenever there is a change to that branch.ReleasesRasa has implemented robust policies governing version naming, as well as release pace for major, minor, and patch releases.The values for a given version number (MAJOR.MINOR.PATCH) are incremented as follows:MAJOR version for incompatible API changes or other breaking changes.MINOR version for functionality added in a backward compatible manner.PATCH version for backward compatible bug fixes.The following table describes the version types and their expectedrelease cadence:Version TypeDescriptionTarget CadenceMajorFor significant changes, or when any backward-incompatible changes are introduced to the API or data model.Every 1 - 2 yrsMinorFor when new backward-compatible functionality is introduced, a minor feature is introduced, or when a set of smaller features is rolled out.+/- QuarterlyPatchFor backward-compatible bug fixes that fix incorrect behavior.As neededWhile this table represents our target release frequency, we reserve the right to modify it based on changing market conditions and technical requirements.Maintenance PolicyOur End of Life policy defines how long a given release is considered supported, as well as how long a release is
considered to be still in active development or maintenance.The maintentance duration and end of life for every release are shown on our website as part of theProduct Release and Maintenance Policy.Cutting a Major / Minor releaseA week before release dayMake sure themilestonealready exists and is scheduled for the
correct date.Take a look at the issues & PRs that are in the milestone: does it look about right for the release highlights
we are planning to ship? Does it look like anything is missing? Don't worry about being aware of every PR that should
be in, but it's useful to take a moment to evaluate what's assigned to the milestone.Post a message on the engineering Slack channel, letting the team know you'll be the one cutting the upcoming
release, as well as:Providing the link to the appropriate milestoneReminding everyone to go over their issues and PRs and please assign them to the milestoneReminding everyone of the scheduled date for the releaseA day before release dayGo over the milestone and evaluate the status of any PR merging that's happening. Follow up with people on their
bugs and fixes.If the release introduces new bugs or regressions that can't be fixed in time, we should discuss on
Slack about this and take a decision on how to move forward. If the issue is not ready to be merged in time, we remove the issue / PR from the milestone and notify the PR owner and the product manager on Slack about it. The PR / issue owners are responsible for
communicating any issues which might be release relevant. Postponing the release should be considered as an edge case scenario.Release day! 🚀At the start of the day, post a small message on slack announcing release day!Communicate you'll be handling
the release, and the time you're aiming to start releasing (again, no later than 4pm, as issues may arise and
cause delays). This message should be posted early in the morning and before moving forward with any of the steps of the release,
in order to give enough time to people to check their PRs and issues. That way they can plan any remaining work. A template of the slack message can be foundhere.
The release time should be communicated transparently so that others can plan potentially necessary steps accordingly. If there are bigger changes this should be communicated.Make sure the milestone is empty (everything has been either merged or moved to the next milestone)Once everything in the milestone is taken care of, post a small message on Slack communicating you are about to
start the release process (in case anything is missing).You may now do the release by following the instructions outlined in theRasa Open Source README!After a Major releaseAfter a Major release has been completed, please followthese instructions to complete the documentation update.Steps to release a new versionReleasing a new version is quite simple, as the packages are build and distributed by GitHub Actions.Release steps:Make sure all dependencies are up to date (especially Rasa SDK)For Rasa SDK, except in the case of a patch release, that means first creating anew Rasa SDK release(make sure the version numbers between the new Rasa and Rasa SDK releases match)Once the tag with the new Rasa SDK release is pushed and the package appears onpypi, the dependency in the rasa repository can be resolved (see below).If this is a minor / major release: Make sure all fixes from currently supported minor versions have been merged from their respective release branches (e.g. 3.3.x) back into main.In case of a minor release, create a new branch that corresponds to the new release, e.g.gitcheckout-b1.2.xgitpushorigin1.2.xSwitch to the branch you want to cut the release from (mainin case of a major, the<major>.<minor>.xbranch for minors and patches)Update therasa-sdkentry inpyproject.tomlwith the new release version and runpoetry update. This creates a newpoetry.lockfile with all dependencies resolved.Commit the changes withgit commit -am "bump rasa-sdk dependency"but do not push them. They will be automatically picked up by the following step.If this is a major release, update the list of actively maintained versionsin the READMEand inthe docs.Runmake releaseCreate a PR against the release branch (e.g.1.2.x)Once your PR is merged, tag a new release (this SHOULD always happen on the release branch), e.g. usinggitcheckout1.2.x
gitpullorigin1.2.x
gittag1.2.0-m"next release"gitpushorigin1.2.0--tagsGitHub will build this tag and publish the build artifacts.After all the steps are completed and if everything goes well then we should see a message automatically posted in the company's Slack (productchannel) like thisoneIf no message appears in the channel then you can do the following checks:Check the workflows inGithub Actionsand make sure that the merged PR of the current release is completed successfully. To easily find your PR you can use the filtersevent: pushandbranch: <version number>(example on release 2.4 you can seehere)If the workflow is not completed, then try to re run the workflow in case that solves the problemIf the problem persists, check also the log files and try to find the root cause of the issueIf you still cannot resolve the error, contact the infrastructure team by providing any helpful information from your investigationAfter the message is posted correctly in theproductchannel, check also in theproduct-engineering-alertschannel if there are any alerts related to the Rasa Open Source release like thisoneCutting a Patch releasePatch releases are simpler to cut, since they are meant to contain only bugfixes.The only things you need to do to cut a patch release are:Notify the engineering team on Slack that you are planning to cut a patch, in case someone has an important fix
to add.Make sure the bugfix(es) are in the release branch you will use (p.e if you are cutting a2.0.4patch, you will
need your fixes to be on the2.0.xrelease branch). All patch releases must come from a.xbranch!Once you're ready to release the Rasa Open Source patch, checkout the branch, runmake releaseand follow the
steps + get the PR merged.Once the PR is in, pull the.xbranch again and push the tag!Additional Release TasksNote: This is only required if the released version is the highest version available.
For instance, perform the following steps when version >versionon main.In order to check compatibility between the new released Rasa version to the latest version of Rasa X/Enterprise, we perform the following steps:Following a new Rasa release, an automated pull request is created inRasa-X-Demo.Once the above PR is merged, follow instructionshere, to release a version.Update the new version in the Rasa X/Enterpriseenv file.
TheRasa-X-Demoproject uses the new updated Rasa version to train and test a model which in turn is used by our CI to run tests in the Rasa X/Enterprise repository,
thus validating compatibility between Rasa and Rasa X/Enterprise.Actively maintained versionsPlease refer to theRasa Product Release and Maintenance Policypage.LicenseLicensed under the Apache License, Version 2.0.
Copyright 2022 Rasa Technologies GmbH.Copy of the license.A list of the Licenses of the dependencies of the project can be found at
the bottom of theLibraries Summary.