Skip to content

Commit

Permalink
Added readme for the private repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ArneMaes0 committed Dec 3, 2024
1 parent aef9fc9 commit 9a02a3c
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 1 deletion.
9 changes: 8 additions & 1 deletion .github/workflows/Automation Master SDK Workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ on:
catalog-identifier:
required: true
type: string
catalog-manifest-path:
required: true
type: string
catalog-readme-path:
required: true
type: string
secrets:
api-key:
required: false
Expand Down Expand Up @@ -357,6 +363,7 @@ jobs:
run: |
IFS=$'\n'
echo dmappPackageName=$(find _DataMinerInstallationPackage -type f -name '*.dmapp') >> $GITHUB_OUTPUT
echo $(find _DataMinerInstallationPackage -type f -name '*.dmapp')
unset IFS
shell: bash
- name: Install .NET Tools
Expand All @@ -366,7 +373,7 @@ jobs:
- name: Upload to Catalog
id: uploadToCatalog
run: echo "id=$(dataminer-catalog-upload with-registration --path-to-artifact "${{ steps.findInstallationPackage.outputs.dmappPackageName }}" --artifact-version ${{ inputs.referenceName }} --catalog-identifier "${{ inputs.catalog-identifier }}" --branch "${{ steps.findBranch.outputs.branch }}" --dm-catalog-token ${{ secrets.api-key }})" >> $GITHUB_OUTPUT
run: echo "id=$(dataminer-catalog-upload with-registration --path-to-artifact "${{ steps.findInstallationPackage.outputs.dmappPackageName }}" --artifact-version ${{ inputs.referenceName }} --catalog-identifier "${{ inputs.catalog-identifier }}" --path-to-readme ${{ inputs.catalog-readme-path }} --path-to-catalog-yml "${{ inputs.catalog-manifest-path }}" --branch "${{ steps.findBranch.outputs.branch }}" --dm-catalog-token ${{ secrets.api-key }})" >> $GITHUB_OUTPUT

- name: (Release) Set artifact Id
run: echo "result-artifact-id=${{ steps.uploadToCatalog.outputs.id }}" >> $GITHUB_ENV
2 changes: 2 additions & 0 deletions .github/workflows/dataminer-cicd-automation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jobs:
owner: ${{ github.repository_owner }}
sonarCloudProjectName: SkylineCommunications_Low-Code-App-Extensions
catalog-identifier: 95a6c64b-42e8-4b01-b154-c55fe2c0750f
catalog-manifest-path: Documentation/CATALOG_PRIVATE_MANIFEST.yml
catalog-readme-path: Documentation/CATALOG_PRIVATE_README.md
secrets:
# The API-key: generated in the DCP Admin app (https://admin.dataminer.services/) as authentication for a certain DataMiner System.
api-key: ${{ secrets.DATAMINER_DEPLOY_KEY }}
Expand Down
78 changes: 78 additions & 0 deletions Documentation/CATALOG_PRIVATE_MANIFEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# [Required]
# Possible values for the Catalog item that can be deployed on a DataMiner System:
# - Automation: If the Catalog item is a general-purpose DataMiner Automation script.
# - Ad Hoc Data Source: If the Catalog item is a DataMiner Automation script designed for an ad hoc data source integration.
# - ChatOps Extension: If the Catalog item is a DataMiner Automation script designed as a ChatOps extension.
# - Connector: If the Catalog item is a DataMiner XML connector.
# - Custom Solution: If the Catalog item is a DataMiner Solution.
# - Data Query: If the Catalog item is a GQI data query.
# - Dashboard: If the Catalog item is a DataMiner dashboard.
# - DevTool: If the Catalog item is a DevTool.
# - Product Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific product.
# - Scripted Connector: If the Catalog item is a DataMiner scripted connector.
# - Standard Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific use case or application.
# - System Health: If the Catalog item is intended to monitor the health of a system.
# - User-Defined API: If the Catalog item is a DataMiner Automation script designed as a user-defined API.
# - Visual Overview: If the Catalog item is a Microsoft Visio design.

type: 'DevTool'

# [Required]
# The ID of the Catalog item.
# All registered versions for the same ID are shown together in the Catalog.
# This ID can not be changed.
# If the ID is not filled in, the registration will fail with HTTP status code 500.
# If the ID is filled in but does not exist yet, a new Catalog item will be registered with this ID.
# If the ID is filled in but does exist, properties of the item will be overwritten.
# Must be a valid GUID.
id: '95a6c64b-42e8-4b01-b154-c55fe2c0750f'

# [Required]
# The human-friendly name of the Catalog item.
# Can be changed at any time.
# Max length: 100 characters.
# Cannot contain newlines.
# Cannot contain leading or trailing whitespace characters.
title: 'SkylineCommunications_Low-Code-App-Editor'

# [Optional]
# General information about the Catalog item.
# Max length: 100,000 characters
# Currently not shown in the Catalog UI but will be supported in the near future.
short_description: 'An interactive Automation script to export, and do some general edits to the low-code apps of a DataMiner System.'

# [Optional]
# A valid URL that points to the source code.
# A valid URL
# Max length: 2048 characters
source_code_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor'

# [Optional]
# A valid URL that points to documentation.
# A valid URL
# Max length: 2048 characters
# Currently not shown in the Catalog UI but will be supported in the near future.
documentation_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor/blob/main/Documentation/README.md'

# [Optional]
# People who are responsible for this Catalog item. Might be developers, but this is not required.
# Format: 'name <email> (url)'
# The name is required; max 256 characters.
# The email and url are optional, and should be in valid email/URL formats.
owners:
- name: 'Arne Maes'
email: '[email protected]'
url: 'https://github.com/ArneMaes0'

# [Optional]
# Tags that allow you to categorize your Catalog items.
# Max number of tags: 5
# Max length: 50 characters.
# Cannot contain newlines.
# Cannot contain leading or trailing whitespace characters.
tags:
- 'Generic'
- 'Tool'
- 'Automation Script'
- 'Low-Code App'
- 'LCA'
7 changes: 7 additions & 0 deletions Documentation/CATALOG_PRIVATE_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# SkylineCommunications_Low-Code-App-Editor

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SkylineCommunications_Low-Code-App-Extensions&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SkylineCommunications_Low-Code-App-Extensions)

> [!CAUTION]
> This item is here for registration purposes only and should not be deployed on it's own!
> To deploy the Low Code App Editor, please see the [Low Code App Editor](https://catalog.dataminer.services/details/e30c5a15-9a8f-465b-83d0-d1de77aa3396) package instead.

0 comments on commit 9a02a3c

Please sign in to comment.