Skip to content

Deploy New Features

As part of Aineko Cloud's recommended GitOps approach, deploying new features should take the following approach:

  1. Create a new branch on your local git repository
  2. Add changes to their local Aineko project
  3. Run it locally and test changes
  4. After testing that it runs successfully, make a GitHub PR
  5. Merge PR after review from collaborators
  6. Aineko Cloud deploys new project into the cloud

We outline some of the above steps.

Create a new branch

We recommend creating a GitHub branch for each new feature as part of Git best practices. This makes it easy to identify issues with code. To do so, run the commands:
git checkout -b feat/my_feature

where feat/my_feature is the name of the branch. We use the prefix feat as a convention to indicate that the branch will be used for a feature (as opposed to a bug fix or documentation or something else).

Developing locally

Since Aineko runs locally using the command aineko run, you can quickly iterate while developing your Aineko project by running it after adding new code.

We recommend making sure your Aineko project runs successfully locally before deploying it to minimize wasting resources deploying Aineko projects that end up crashing in the cloud.

Making a PR

To push a new version of the Aineko project (on its own branch) to GitHub, run
git add .
git commit -m "feat: implemented my new feature"
git push --set-upstream origin feat/my_feature

Every commit needs to have an associated message, which we add using the -m flag, and we recommend following these conventions.

Note that the last line is only needed for the first push for this specific branch. For subsequent ones, the command git push will suffice.

After pushing the branch, navigate to the GitHub repository webpage and create a pull request.

Deploy Project

Once the PR has been reviewed and merged, Aineko Cloud automatically deploys your pipeline. Check the workflows page for the status of the deployment.