Skip to content

Commit

Permalink
Release dev to main branch (#215)
Browse files Browse the repository at this point in the history
This re-releases #206 and #211 now using the release pipeline, which
also updates the prod images in the Container Registry.

----

This PR marks the full release of FarmVibes.AI's source code with an
open source license.

This PR also introduces several significant updates to the development
environment, build workflows, and continuous integration processes. The
most important changes include the addition of a development container
configuration, updates to GitHub workflows for building and testing, and
the introduction of new settings for code linting and formatting.

### Development Environment Updates:
*
[`.devcontainer/devcontainer.json`](diffhunk://#diff-24ad71c8613ddcf6fd23818cb3bb477a1fb6d83af4550b0bad43099813088686R1-R62):
Added a new devcontainer configuration with custom VSCode settings and
extensions, Docker mounts, and environment variables.
*
[`.devcontainer/post-create.sh`](diffhunk://#diff-bcf66a848607b49d2a45edfad434f6808017ee9d18f5a20dde6670745010d89aR1-R71):
Added a post-create script to set up the development environment,
including SSH configuration, Python virtual environment setup, and
installation of necessary tools and dependencies.

### Build and Deployment Workflows:
*
[`.github/workflows/base-build.yml`](diffhunk://#diff-034a91a8f3709fafd1219e587ce389e3a39338ac6adbe543d524bcb1e84b2cf3R1-R64):
Added a new workflow for building and pushing base Docker images,
including steps for Azure CLI login and updating image tags.
*
[`.github/workflows/docker-build.yml`](diffhunk://#diff-3414847e2ad632333f775cabb810f0dc0df61a570365df34750a08b00912fe82R1-R41):
Introduced a workflow for building and pushing service Docker images on
push events to the `dev` and `main` branches.
*
[`.github/workflows/release-to-main.yml`](diffhunk://#diff-b55efbebc7173bd35e8aa625b689d11a521f0ea54f064ae7a2be9cbf5c5fa1a4R1-R54):
Added a workflow to handle the release process, including retagging
Docker images and updating the default image tag in the codebase.

### Continuous Integration:
*
[`.github/workflows/lint-test.yml`](diffhunk://#diff-1dccad827a8e5157df1dcdb70b73e454524c2586ebc64576af82cb348d478892R1-R197):
Created a comprehensive workflow for linting, type checking, and testing
the codebase across multiple packages and environments.

### Code Linting and Formatting:
*
[`.ruff.toml`](diffhunk://#diff-b3236d4cb260ca6acce083493fcdc42816f732fc3d5aefb263a3c3fe9db4f81fR1-R17):
Added configuration for the `ruff` linter, specifying linting rules,
file exclusions, and formatting preferences.

These changes aim to ensure FarmVibes.AI's longevity, to streamline the
development process, ensure consistent code quality, and automate the
build and deployment pipelines.

---------

Co-authored-by: FarmVibes Release Pipeline <farmvibesaicd@microsoft.com>
Co-authored-by: Alex Crown <acrown@microsoft.com>
Co-authored-by: Bruno Silva <brunosilva@microsoft.com>
Co-authored-by: Eduardo Rodrigues <edrodrigues@microsoft.com>
Co-authored-by: Jessica Wolk <Jessica.Wolk@microsoft.com>
Co-authored-by: Leonardo Nunes <lnunes@microsoft.com>
Co-authored-by: Naga Bilwanth Gangarapu <Naga@zensa.co>
Co-authored-by: Rafael Padilha <rpadilha@microsoft.com>
Co-authored-by: Rick Gutierrez <ricardgu@microsoft.com>
Co-authored-by: Roberto de Moura Estevão Filho <robertode@microsoft.com>
Co-authored-by: Roberto Santos <robsantos@microsoft.com>
Co-authored-by: Sara Malvar <saramalvar@microsoft.com>
Co-authored-by: Naga Bilwanth Gangarapu <82965480+v-ngangarapu@users.noreply.github.com>
  • Loading branch information
14 people authored Nov 29, 2024
1 parent 52027cd commit a9e999f
Show file tree
Hide file tree
Showing 793 changed files with 56,801 additions and 1,102 deletions.
62 changes: 62 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{
"build": {
"dockerfile": "../resources/docker/Dockerfile-devcontainer"
},
"overrideCommand": false,
"mounts": [
"type=bind,source=${localEnv:HOME}${localEnv:USERPROFILE},target=/user-home",
"source=terravibes-devcontainer-profile,target=/home/vscode,type=volume",
"target=/home/vscode/.vscode-server,type=volume",
"source=terravibes-devcontainer-var-lib-docker,target=/var/lib/docker,type=volume"
],
"customizations": {
"vscode": {
"extensions": [
"charliermarsh.ruff",
"ms-python.python",
"ms-python.vscode-pylance",
"ms-toolsai.jupyter",
"ms-azuretools.vscode-docker",
"DavidAnson.vscode-markdownlint",
"ms-vscode-remote.remote-containers",
"eamodio.gitlens",
"mutantdino.resourcemonitor"
],
"settings": {
"python.defaultInterpreterPath": "/opt/venv/bin/python",
"python.testing.pytestArgs": [
"src",
"ops"
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
},
"python.analysis.typeCheckingMode": "basic",
"python.analysis.diagnosticMode": "workspace",
"python.terminal.activateEnvironment": false,
"python.linting.flake8Enabled": true,
"git.autofetch": "all",
"terminal.integrated.allowChords": false,
"[python]": {
"editor.formatOnSave": true,
"editor.defaultFormatter": "charliermarsh.ruff"
}
}
}
},
"remoteUser": "vscode",
"updateRemoteUserUID": true,
"postCreateCommand": "sed 's/\r$//' .devcontainer/post-create.sh | bash -",
"runArgs": [
"--init",
"--privileged"
],
"containerEnv": {
"USER": "vscode",
"PATH": "/home/vscode/.local/bin:/opt/venv/bin:/opt/conda/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
}
}
71 changes: 71 additions & 0 deletions .devcontainer/post-create.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
#!/bin/sh
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.


DOCKER_VERSION=24.0.2
VSCODE_HOME=/home/vscode

if [ -d /user-home/.ssh ]; then
echo "Making user ssh available in container..."
mkdir -p $VSCODE_HOME/.ssh
chmod 0700 $VSCODE_HOME/.ssh
for f in /user-home/.ssh/*
do
cp "$f" $VSCODE_HOME/.ssh/"$(basename "$f")"
chmod 0600 $VSCODE_HOME/.ssh/"$(basename "$f")"
done
fi

# If the user has a git config file, copy it
if [ -f /user-home/.gitconfig ]; then
echo "Copying user .gitconfig..."
cp /user-home/.gitconfig $VSCODE_HOME/.gitconfig
echo "Enabling HTTP use path, in case the user cloned with HTTP"
git config --global credential.useHttpPath true
fi

if [ "$(stat -c '%u' .)" != "$UID" ]; then
echo "The permissions of the current directory differ from the current user,"
echo "which means we're probably running in Docker under a Windows host..."
echo "Adding the current directory to the git safe directory list"
git config --global --add safe.directory /workspaces/TerraVibes
fi

sudo mkdir /opt/venv
sudo chown vscode /opt/venv
/opt/conda/bin/python3 -m venv --system-site-packages /opt/venv || exit 1
/opt/venv/bin/pip install --upgrade pip

if [[ "$(uname -a)" == *"WSL2"* ]]; then
# We're either in WSL2 or in a Windows host
echo "If we're on a Windows host, we need to convert files to unix mode..."
find cli scripts -type f -exec dos2unix --allow-chown {} \;
fi

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended
zsh -c "zstyle ':omz:update' mode auto"
zsh -c "zstyle ':omz:update' verbose minimal"
git clone https://github.com/zsh-users/zsh-autosuggestions.git ~/.oh-my-zsh/plugins/zsh-autosuggestions
git clone https://github.com/zsh-users/zsh-syntax-highlighting.git $ZSH_CUSTOM/plugins/zsh-syntax-highlighting
git clone --depth 1 -- https://github.com/marlonrichert/zsh-autocomplete.git $ZSH_CUSTOM/plugins/zsh-autocomplete
sed -i 's/plugins=(git)/plugins=(git zsh-autosuggestions zsh-syntax-highlighting zsh-autocomplete)/g' ~/.zshrc
echo "export LD_LIBRARY_PATH=/opt/conda/lib:\$LD_LIBRARY_PATH" >> ~/.zshrc
echo "export LD_LIBRARY_PATH=/opt/conda/lib:\$LD_LIBRARY_PATH" >> ~/.bashrc

/opt/venv/bin/pip install --upgrade pyright
/opt/venv/bin/pip install --upgrade "pytest" "anyio[trio]"
sed -e '1,/dependencies:/d' < resources/envs/dev.yaml | \
sed 's/-//' | \
xargs /opt/venv/bin/pip install
eval $(grep 'terravibes_packages=' < "scripts/setup_python_develop_env.sh")
for package in $terravibes_packages
do
/opt/venv/bin/pip install -e src/$package
done

sudo mkdir -p /opt/terravibes/ops
sudo ln -sf $(pwd)/op_resources /opt/terravibes/ops/resources
sudo mkdir /app
sudo ln -sf $(pwd)/ops /app/ops
sudo ln -sf $(pwd)/workflows /app/workflows
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.onnx filter=lfs diff=lfs merge=lfs -text
*.xls filter=lfs diff=lfs merge=lfs -text
*.kml filter=lfs diff=lfs merge=lfs -text
*.tif filter=lfs diff=lfs merge=lfs -text
64 changes: 64 additions & 0 deletions .github/workflows/base-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Build base images
on:
workflow_dispatch:

permissions:
id-token: write
contents: write

jobs:

build-and-push:
runs-on: ubuntu-latest
environment: build
strategy:
matrix:
include:
- dockerfile: Dockerfile-services-base
image-name: services-base
- dockerfile: Dockerfile-worker-base
image-name: worker-base
steps:
- uses: actions/checkout@v4
with:
ref: dev
- name: 'Az CLI login'
uses: azure/login@v1
with:
client-id: ${{ secrets.AZURE_CLIENT_ID }}
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
- name: 'Build and push image'
run: |
az acr login -n ${{ secrets.ACR_NAME }}
VERSION_TAG=${{ github.run_id }}
export IMAGE_TAG=${{ secrets.ACR_NAME }}.azurecr.io/unlisted/farmai/terravibes/${{ matrix.image-name }}:$VERSION_TAG
docker build . -f ./resources/docker/${{ matrix.dockerfile }} -t $IMAGE_TAG
docker push $IMAGE_TAG
update-tags:
needs: build-and-push
runs-on: ubuntu-latest
environment: build
steps:
- uses: actions/checkout@v4
with:
ref: dev
ssh-key: ${{ secrets.WORKFLOW_KEY }}
- name: 'Update tags'
run: |
TAG=${{ github.run_id }}
sed -i "s|\(\s\+image.*:\).*|\1${TAG}|" ./.github/workflows/lint-test.yml
sed -i "s|\(FROM.*:\).*|\1${TAG}|" ./resources/docker/Dockerfile-api_orchestrator
sed -i "s|\(FROM.*:\).*|\1${TAG}|" ./resources/docker/Dockerfile-cache
sed -i "s|\(FROM.*:\).*|\1${TAG}|" ./resources/docker/Dockerfile-worker
sed -i "s|\(FROM.*:\).*|\1${TAG}|" ./resources/docker/Dockerfile-devcontainer
- name: Commit changes
run: |
git config --global user.email "farmvibesaicd@microsoft.com"
git config --global user.name "FarmVibes.AI Release Pipeline"
BRANCH=update-base-${{ github.run_id }}
git checkout -b $BRANCH
git add ./.github/workflows/lint-test.yml
git add ./resources/docker/
git commit -m "Update base tag to latest image"
git push --set-upstream origin $BRANCH
96 changes: 0 additions & 96 deletions .github/workflows/cluster-build.yml

This file was deleted.

41 changes: 41 additions & 0 deletions .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build service images
on:
push:
branches:
- dev
- main

permissions:
id-token: write
contents: read
jobs:
build-and-push:
runs-on: ubuntu-latest
environment: build
strategy:
matrix:
include:
- dockerfile: Dockerfile-api_orchestrator
image-name: api-orchestrator
- dockerfile: Dockerfile-worker
image-name: worker
- dockerfile: Dockerfile-cache
image-name: cache
steps:
- uses: actions/checkout@v4
with:
lfs: true
- name: 'Az CLI login'
uses: azure/login@v1
with:
client-id: ${{ secrets.AZURE_CLIENT_ID }}
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
- name: 'Build and push image'
run: |
az acr login -n ${{ secrets.ACR_NAME }}
export VERSION_TAG=${GITHUB_REF#refs/heads/}
export IMAGE_TAG=${{ secrets.ACR_NAME }}.azurecr.io/unlisted/farmai/terravibes/${{ matrix.image-name }}:$VERSION_TAG
docker build . -f ./resources/docker/${{ matrix.dockerfile }} -t $IMAGE_TAG
docker push $IMAGE_TAG
Loading

0 comments on commit a9e999f

Please sign in to comment.