Note Used within Bever
This is a reusable workflow that builds the project, creates a new release, uploads the solution files to Azure Blob Storage, and updates the Azure SQL Database.
Create a workflow .yml file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for creating a workflow file.
| Name | Required | Type | Default | Options | Description |
|---|---|---|---|---|---|
| control-title | Required | string | --- | --- | Control title |
| control-description | Optional | string | --- | --- | Control description (included in use-default) |
| control-youtube-video-url | Optional | string | --- | --- | Control youtube video url |
| control-thumbnail-url | Optional | string | --- | --- | Control thumbnail url (included in use-default) |
| control-primary-image-url | Optional | string | --- | --- | Control primary image url (included in use-default) |
| control-markdown-file-url | Optional | string | --- | --- | Cotnrol markdown file url (included in use-default) |
| control-tags | Optional | string | Bever-Controls, PCF | --- | Control tags (comma separated | added by default `Bever-Controls, PCF, <control unique name>`) |
| solution-folder | Optional | string | Solution | --- | Final solution directory |
| pcfproj-prefix | Optional | string | PCF- | --- | File name prefix of the .pcfproj |
| release-solution-package-type | Optional | string | managed | none, unmanaged, managed, both | The solution package type to add to the created release as assets |
| azure-solution-package-type | Optional | string | managed | unmanaged, managed, both | The solution package type to upload to Azure blob storage |
| create-new-release | Optional | boolean | true | --- | Create a new release on GitHub or not |
| delete-old-version-from-azure | Optional | boolean | true | --- | Delete the old solution directory from Azure blob storage or not |
| use-default | Optional | boolean | true | --- | Use default information for control inputs |
| node-version | Optional | number | 16 | --- | Node version |
| Name | Type | Description | Example |
|---|---|---|---|
| solution-unique-name | string | The solution unique name | SampleCustomComponent |
| solution-version | string | The solution version | 1.0.0 |
| solution-parsed-version | string | The solution namespace | 1_0_0 |
| solution-namespace | string | The solution parsed version | BeverControls |
| release-id | string | Created release ID | |
| release-name | string | Created release name | v1.0.0 |
| release-tag-name | string | Created release tag name | v1.0.0 |
| release-url | string | Created release URL, the URL users can navigate to in order to view the release | https://github.com/BeverCRM/PCF-SampleCustomComponent/releases/tag/v1.0.0 |
On every push (or pull request merge) on the release branch, run this workflow.
name: Create a new release and upload the solution to Azure blob storage CI
on:
push:
branches: release
jobs:
main:
uses: BeverCRM/Workflow-Build-Release-Upload-Update/.github/workflows/build-release-upload-update-rw.yml@master
secrets: inherit
with:
control-title: Sample Custom Component # required
# control-description: '' # default
# control-youtube-video-url: '' # default
# control-thumbnail-url: '' # included in use-default
# control-primary-image-url: '' # included in use-default
# control-markdown-file-url: '' # included in use-default
# control-tags: Bever-Controls, PCF # added by default
# solution-folder: Solution # default
# pcfproj-prefix: PCF- # default
# release-solution-package-type: managed # default
# azure-solution-package-type: managed # default
# create-new-release: true # default
# delete-old-version-from-azure: true # default
# use-default: true # default
# node-version: 16 # defaultFor more information on how to create a PCF repository see BeverCRM/Template-PCF.