Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/powerplatform-actions

Power Platform GitHub Actions automate common build and deployment tasks related to Power Platform. This includes synchronization of solution metadata (a.k.a. solutions) between development environments and source control, generating build artifacts, deploying to downstream environments, provisioning/de-provisioning of environments, and the ability to perform static analysis checks against your solution using the PowerApps checker service.
https://github.com/microsoft/powerplatform-actions

github-actions powerplatform

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/microsoft/powerplatform-actions
Owner: microsoft
License: mit
Created: 2020-08-06T19:28:51.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-09-16T20:39:13.000Z (17 days ago)
Last Synced: 2024-09-20T07:30:57.490Z (13 days ago)
Topics: github-actions, powerplatform
Language: TypeScript
Homepage:
Size: 35.2 MB
Stars: 213
Watchers: 31
Forks: 65
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Power Platform Actions

This repo provides multiple [GitHub Actions for the Power Platform](https://aka.ms/PowerPlatformGitHub); for more general info on [GitHub Actions](https://help.github.com/en/actions).

Each action wraps the existing [Power Platform CLI](https://aka.ms/PowerPlatformCLI).

Detailed documentation on GitHub actions for Power Platform is available [here](https://aka.ms/poweractionsdocs).

Sample workflows and detailed instructions are available in our [GitHub actions lab repo](https://github.com/microsoft/powerplatform-actions-lab)

but if you are already familiar with GitHub actions and Power Platform solutions, simply add below to your existing workflows;

also add the secret `MYPASSWORD` to your repository's 'Settings' | 'Secrets'

```yaml

jobs:

  build:

    runs-on: windows-latest   # alternate runner OS is: ubuntu-latest

    steps:

    - name: Install Power Platform Tools

      uses: microsoft/powerplatform-actions/actions-install@v1

    - name: Export Solution

      uses: microsoft/powerplatform-actions/export-solution@v1

      with:

        environment-url: 'https://myenv.crm.dynamics.com'

        user-name: '[email protected]'

        password-secret: ${{ secrets.MYPASSWORD }}

        solution-name: aSolution

        solution-output-file: 'aSolution.zip'

        working-directory: 'out'

    - name: Unpack Solution

      uses: microsoft/powerplatform-actions/unpack-solution@v1

      with:

        solution-file: 'out/aSolution1.zip'

        solution-folder: 'out/solutions/solution one'

        solution-type: 'Unmanaged'

        overwrite-files: true

    - name: Publish Solution

      uses: microsoft/powerplatform-actions/publish-solution@v1

      with:

        environment-url: 'https://myenv.crm.dynamics.com'

        user-name: '[email protected]'

        password-secret: ${{ secrets.MYPASSWORD }}

    - name: Prepare solution changes for check-in into source control

      uses: microsoft/powerplatform-actions/branch-solution@v1

      with:

        solution-folder: 'out/solutions/solution one'

        solution-target-folder: 'src/solutions/solution1'

        token: ${{ secrets.GITHUB_TOKEN }}

```

[![pull-request-validation](https://github.com/microsoft/powerplatform-actions/actions/workflows/pull-request.yml/badge.svg)](https://github.com/microsoft/powerplatform-actions/actions/workflows/pull-request.yml)

## Contributing

This project will welcome community contributions in the near future. For suggestions and ideas, please use the [Issues section](https://github.com/microsoft/powerplatform-actions/issues) of this repo.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Setting Up Dev Environment

Windows, macOS or Linux:

- [Node.js LTS (currently v12)](https://nodejs.org/en/download/)

- gulp CLI: ```npm install -g gulp-cli```

- [git](https://git-scm.com/downloads)

- [VS Code](https://code.visualstudio.com/Download) or your different favorite editor

- recommended VSCode extensions:

  - [EditorConfig for VS Code (editorconfig.editorconfig)](https://github.com/editorconfig/editorconfig-vscode)

  - [ESLint (dbaeumer.vscode-eslint)](https://github.com/Microsoft/vscode-eslint)

  - [GitLens (eamodio.gitlens)](https://github.com/eamodio/vscode-gitlens)

  - [markdownlint (davidanson.vscode-markdownlint)](https://github.com/DavidAnson/vscode-markdownlint)

  - [Mocha sidebar (maty.vscode-mocha-sidebar)](https://github.com/maty21/mocha-sidebar)

- TEMPORARY:

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

  ```Powershell

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

  ```

  - Create a [PAT in GitHub](https://github.com/settings/tokens) to read packages, and enable SSO for the microsoft organization.

  Then add it to your *~/.npmrc* file or use the `npm login --scope=@microsoft --registry=https://npm.pkg.github.com` command,

  as documented [here](https://docs.github.com/en/packages/guides/configuring-npm-for-use-with-github-packages#authenticating-with-a-personal-access-token).

  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](https://docs.github.com/en/github/managing-large-files/installing-git-large-file-storage) for your environment.

## Getting Started

Clone, restore modules, build and run:

```bash

git clone https://github.com/microsoft/powerplatform-actions.git

cd powerplatform-actions

npm install

gulp

```

## Refreshing actions in dist folder

In a clean working directory, run ```npm run update-dist``` and commit and push only the updates in the ```./dist``` folder.

If you have updated the Linux PAC package version (especially from a Windows host), double check that the `pac` executable has the execute flag set.  Run

```bash

git ls-tree HEAD dist/pac_linux/tools/pac

```

and check that the leftmost value should be `100755`.  Example output:

```bash

100755 blob 00034fe2fe80faca43030481877760674409d739    dist/pac_linux/tools/pac

```

If the file mode does not match, run

```bash

git update-index --chmod=+x dist/pac_linux/tools/pac

```

prior to commiting the changes.

## Details

[CLI command for pac](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/powerapps-cli#solution)

## References

### ADAL/MSAL

### CustomerEngagement API

- [WebAPI](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/overview)

- [WebAPI REST API](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/about?view=dynamics-ce-odata-9)

- [OrgService](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/org-service/overview)

- [Org url discovery](https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/discover-url-organization-web-api)

### Power Platform Environment Admin (BAP)

- [Environments Overview](https://docs.microsoft.com/en-us/power-platform/admin/environments-overview)

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

[Please refer steps in Cli-Wrapper](https://github.com/microsoft/powerplatform-cli-wrapper/blob/main/README.md)