Deployment Process
New Version of DAS AtomDB
- Go to the repository at AtomDB repository.
To publish a new version of DAS AtomDB, the first step is to access the AtomDB repository.
- Update the version parameter in pyproject.toml
Before starting to publish the version, it is crucial to ensure that the pyproject.toml file is updated with the number of the desired new version, locating and changing the version parameter in the [tool.poetry] section.
- Commit the changes
After this change, it is necessary to commit to the master branch to record the change.
- Verify latest created tag before versioning
It is important to note what the last version created was at https://github.com/singnet/das-atom-db/tags before creating a new version.
- Execute PyPI Publishing Workflow Navigate to Actions, select the "Publish to PyPI" workflow, and click on "Run workflow." Choose the master branch, enter the version number in the form that appears (format: 1.0.0) ensure that the inserted version matches the one previously added in the pyproject.toml file, and click the "Run workflow" button.
- Monitor the workflow execution. Ensure all jobs complete successfully.
After the workflow execution, refresh the page and check if a new workflow is running. By clicking on it, you can track all jobs. At the end of the process, all jobs should have a green check mark. If there is an error in any job, it is possible to click on it to view the logs and identify the cause of the problem.
- Verify the new tag at DAS AtomDB repository tags and pypi project history.
If everything goes as expected, the new version tag should be available at https://github.com/singnet/das-atom-db/tags and https://pypi.org/project/hyperon-das-atomdb/#history.
New Version of DAS Query Engine
- Go to the repository at the Query Engine repository.
To publish a new version of DAS Query Engine, follow a process similarto the one described above for Das AtomDB. Access the repository athttps://github.com/singnet/das-query-engine
- Update the version parameter in pyproject.toml
Make sure to update the version number in the pyproject.toml file. Additionally, it is necessary to update the version of hyperon-das-atomdb in the dependencies, as specified in the [tool.poetry.dependencies] section.
- Commit this change to the master branch.
After this change, it is necessary to commit to the master branch to record the change.
- Verify latest created tag before versioning
It is important to note what the last version created was at https://github.com/singnet/das-query-engine/tags before creating a new version.
- Execute PyPI Publishing Workflow
Initiate the 'Publish to PyPI' Workflow Manually via the 'Actions' Tab in the Repository. Click 'Run workflow' and proceed with the provided instructions, ensuring the master branch is selected. Enter the desired version number in the format 1.0.0, then click 'Run workflow' to proceed.
- Monitor the workflow execution. Ensure all jobs complete successfully.
Just like in the case of DAS AtomDB, refresh the page and check if a new workflow is running. By clicking on it, you can track all jobs. At the end of the process, all jobs should have a green check mark. If there is an error in any job, it is possible to click on it to view the logs and identify the cause of the problem.
- Verify the new tag at DAS Query Engine repository tags and pypi project history.
If everything goes as expected, the new version tag should be available at https://github.com/singnet/das-query-engine/tags and https://pypi.org/project/hyperon-das/#history.
New Version of DAS Serverless Functions
- Navigate to the DAS Serverless Functions repository.
- Update the hyperon-das version in the requirements file
Update the version of the hyperon-das in the das-query-engine/requirements.txt file. This ensures that the correct version is used during the workflow build.
- Commit the change to the master branch.
After this change, it is necessary to commit to the master branch to record the change.
- Verify latest created tag before versioning
It is important to note what the last version created was at https://github.com/singnet/das-serverless-functions/tags before creating a new version.
- Select the "Vultr Build" workflow in Actions and run it manually.
Manually trigger the 'Vultr Build' workflow via the 'Actions' tab in the repository. Ensure the master branch is selected, then input the desired version number following the format 1.0.0. Next, choose 'das-query-engine' from the dropdown menu, and finally, click 'Run workflow' to proceed.
- Monitor the workflow execution. Ensure all jobs complete successfully.
After the workflow execution, refresh the page and check if a new workflow is running. By clicking on it, you can track all jobs. At the end of the process, all jobs should have a green check mark. If there is an error in any job, it is possible to click on it to view the logs and identify the cause of the problem.
- Verify the new tag at DAS Serverless Functions repository tags and Docker Hub.
It is important to note that this pipeline should generate an img on Docker Hub, following the format 1.0.0-queryengine. Make sure that the img is generated correctly and available at https://hub.docker.com/r/trueagi/das/tags. After the workflow execution, verify if all jobs were successfully completed. The new version tag should be available at https://github.com/singnet/das-serverless-functions/tags.
Deploying the Built Image to Production and Development Environments
- For deployment, navigate to DAS Infra Stack Vultr repository.
The publication process of the img generated in the production and development environments is carried out in the das-infra-stack-vultr repository.
- Update requirements.txt and das-function.yml.
Before starting the deployment, it is necessary to update the version of hyperon-das in the requirements.txt file, ensuring that the correct version is used during integration tests. Before committing the changes to a branch, make the necessary changes in the das-function.yml file, updating the image version to the one generated earlier.
- Commit/Merge the changes to the develop branch.
Commit your changes to the 'develop' branch or merge them into the 'develop' branch for deployment to the development environment. Following the merge, the 'Vultr Deployment' pipeline will initiate automatically. Verify the successful completion of all jobs with the 'develop' suffix to ensure the development environment is accurately updated.
- Merge develop branch into master.
After verification, make a PR from develop to master. After the merge to master, check if all jobs were successfully completed, ensuring that the production environment is correctly updated. If errors occur during tests, they are likely related to the response format, which may have been changed due to previously published libraries. In case of problems, it is possible to rollback the version by reverting the commit to return to the previous version.
New Version of DAS Metta Parser
- Go to the repository at the DAS Metta Parser repository.
To publish a new version of DAS Metta Parser, access the repository athttps://github.com/singnet/das-metta-parser
- Verify latest created tag before versioning
It is important to note what the last version created was at https://github.com/singnet/das-metta-parser/tags before creating a new version.
- Execute DAS Metta Parser Build Workflow
Initiate the 'DAS Metta Parser Build' Workflow Manually via the 'Actions' Tab in the Repository. Click 'Run workflow' and proceed with the provided instructions, ensuring the master branch is selected. Enter the desired version number in the format 1.0.0, then click 'Run workflow' to proceed.
- Monitor the workflow execution. Ensure all jobs complete successfully.
Refresh the page and check if a new workflow is running. By clicking on it, you can track all jobs. At the end of the process, all jobs should have a green check mark. If there is an error in any job, it is possible to click on it to view the logs and identify the cause of the problem.
- Verify the new tag at DAS Metta Parser repository tags and Docker Hub.
It is important to note that this pipeline should generate an image on Docker Hub, following the format 1.0.0-toolbox. Make sure that the image is generated correctly and available at https://hub.docker.com/r/trueagi/das/tags. After the workflow execution, verify if all jobs were successfully completed. The new version tag should be available at https://github.com/singnet/das-metta-parser/tags.
New version of DAS Toolbox
- Go to the DAS Toolbox repository.
To publish a new version of DAS Toolbox, access the repository at https://github.com/singnet/das-toolbox/.
- Update the toolbox image version in src/config/config.py
Ensure to update the toolbox image version number in the src/config/config.py file. This is important because syntax check and loader are executed from this toolbox image.
- Commit this change to the master branch.
After this change, it is necessary to commit to the master branch to record the change.
- Verify latest created tag before versioning
It is important to note what the last version created was at https://github.com/singnet/das-toolbox/tags before creating a new version.
- Run the "DAS CLI Build" workflow from Actions.
Manually execute the “DAS CLI Build” workflow through the “Actions” tab in the repository. Click 'Run workflow' and proceed with the provided instructions, ensuring the master branch is selected. Enter the desired version number in the format 1.0.0, then click 'Run workflow' to proceed.
- Monitor the workflow execution. Ensure all jobs complete successfully.
After the workflow execution, refresh the page and check if a new workflow is running. By clicking on it, you can track all jobs. At the end of the process, all jobs should have a green check mark. If there is an error in any job, it is possible to click on it to view the logs and identify the cause of the problem.
- Verify the new tag at DAS Toolbox repository tags
After the workflow execution, verify if all jobs were successfully completed. The new version tag should be available at https://github.com/singnet/das-toolbox/tags. Additionally, the CLI file generated by the pipeline will be available for download in the workflow artifacts, allowing its use locally.
