CONTRIBUTING.md

Contributing

This project will welcome code and PR contributions and suggestions in the near future. While we are excited to accept code contributions, there are other valuable forms of contributions, including filing issues and engaging in discussions. Many open source projects ask for enhancement suggestions in the form of issues. We prefer that you start an idea discussion instead of creating enhancement issues.

Once this project is ready to welcome 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.

Setting Up Local Dev Environment

Windows, macOS or Linux:

• Node.js LTS (currently v16)
• Install the Azure CLI
  • Add Azure DevOps Extension
    • az extension add --name azure-devops
• gulp CLI: npm install -g gulp-cli
• git
• VS Code or your different favorite editor
• recommended VSCode extensions:

  • EditorConfig for VS Code (editorconfig.editorconfig)

  • ESLint (dbaeumer.vscode-eslint)

  • GitLens (eamodio.gitlens)

  • markdownlint (davidanson.vscode-markdownlint)

  • TEMPORARY:

    • Create a PAT for the Azure DevOps org msazure with scope: package(read) and add it as local environment variable.

    [Environment]::SetEnvironmentVariable('AZ_DevOps_Read_PAT', '<yourPAT>', [EnvironmentVariableTarget]::User)

    • Create a PAT in GitHub to read packages, and enable SSO for the microsoft organization. Then add it to your ~/.npmrc file or use the npm login command as documented here. This will only be needed until the @microsoft/powerplatform-cli-wrapper repo is made public.

If developing on Linux or macOS, you will also need to install git-lfs. (It is prepackaged with the Git installer for Windows.) Follow the instructions here for your environment.

Build and Run

Clone, restore modules, build and run:

git clone https://github.com/microsoft/powerplatform-build-tools.git pp-build-tools
cd pp-build-tools
npm ci
gulp ci

How to make GitHub Actions and Build Tools compatible with latest PAC CLI?

Please refer steps in Cli-Wrapper