Contribution

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.

Prerequisites

Before you begin, ensure you have the following installed:

• Python (version 3.10 or higher)
• PowerShell
• Azure CLI or Az.Accounts PowerShell module
• Visual Studio Code (VS Code)

Initial Configuration

1. Fork the Repository on GitHub:

   • Go to the repository fabric-cicd on GitHub.
   • In the top right corner, click on the Fork button.
   • This will create a copy of the repository in your own GitHub account.

2. Clone Your Forked Repository:

   • Once the fork is complete, go to your GitHub account and open the forked repository.
   • Click on the Code button, and clone to VS Code.

3. Run activate.ps1:

   • Open the Project in VS Code
   • Open PowerShell terminal
   • Run activate.ps1 which will install uv, and ruff if not already found. And set up the default environment leveraging uv sync.

     .\activate.ps1
     

     Note that this is technically optional and is designed to work with PowerShell. You can execute these steps manually as well, this is merely a helper

4. Select Python Interpreter:

   • Open the Command Palette (Ctrl+Shift+P) and select Python: Select Interpreter.
   • Choose the interpreter from the venv directory.

5. Ensure All VS Code Extensions Are Installed:

   • Open the Command Palette (Ctrl+Shift+P) and select Extensions: Show Recommended Extensions.
   • Install all extensions recommended for the workspace.

Development

Managing Dependencies

• All dependencies in this project are managed by uv which will resolve all dependencies and lock the versions to speed up virtual environment creation.
• For additions, run:

  uv add <package-name>
  

• For removals, run:

  uv remove <package-name>
  

Code Formatting & Linting

• The python code within this project is maintained by ruff.
• If you install the recommended extensions, ruff will auto format on save of any file.
• Before being able to merge a PR, ruff is ran in a Github Action to ensure the files are properly formatted and maintained.
• To force linting, run the following.

  ruff format
  ruff check