Skip to content

Commit 9a02a3c

Browse files
committed
Added readme for the private repo
1 parent aef9fc9 commit 9a02a3c

4 files changed

+95
-1
lines changed

.github/workflows/Automation Master SDK Workflow.yml

+8-1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ on:
3636
catalog-identifier:
3737
required: true
3838
type: string
39+
catalog-manifest-path:
40+
required: true
41+
type: string
42+
catalog-readme-path:
43+
required: true
44+
type: string
3945
secrets:
4046
api-key:
4147
required: false
@@ -357,6 +363,7 @@ jobs:
357363
run: |
358364
IFS=$'\n'
359365
echo dmappPackageName=$(find _DataMinerInstallationPackage -type f -name '*.dmapp') >> $GITHUB_OUTPUT
366+
echo $(find _DataMinerInstallationPackage -type f -name '*.dmapp')
360367
unset IFS
361368
shell: bash
362369
- name: Install .NET Tools
@@ -366,7 +373,7 @@ jobs:
366373
367374
- name: Upload to Catalog
368375
id: uploadToCatalog
369-
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
376+
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
370377

371378
- name: (Release) Set artifact Id
372379
run: echo "result-artifact-id=${{ steps.uploadToCatalog.outputs.id }}" >> $GITHUB_ENV

.github/workflows/dataminer-cicd-automation.yml

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525
owner: ${{ github.repository_owner }}
2626
sonarCloudProjectName: SkylineCommunications_Low-Code-App-Extensions
2727
catalog-identifier: 95a6c64b-42e8-4b01-b154-c55fe2c0750f
28+
catalog-manifest-path: Documentation/CATALOG_PRIVATE_MANIFEST.yml
29+
catalog-readme-path: Documentation/CATALOG_PRIVATE_README.md
2830
secrets:
2931
# The API-key: generated in the DCP Admin app (https://admin.dataminer.services/) as authentication for a certain DataMiner System.
3032
api-key: ${{ secrets.DATAMINER_DEPLOY_KEY }}
+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# [Required]
2+
# Possible values for the Catalog item that can be deployed on a DataMiner System:
3+
# - Automation: If the Catalog item is a general-purpose DataMiner Automation script.
4+
# - Ad Hoc Data Source: If the Catalog item is a DataMiner Automation script designed for an ad hoc data source integration.
5+
# - ChatOps Extension: If the Catalog item is a DataMiner Automation script designed as a ChatOps extension.
6+
# - Connector: If the Catalog item is a DataMiner XML connector.
7+
# - Custom Solution: If the Catalog item is a DataMiner Solution.
8+
# - Data Query: If the Catalog item is a GQI data query.
9+
# - Dashboard: If the Catalog item is a DataMiner dashboard.
10+
# - DevTool: If the Catalog item is a DevTool.
11+
# - Product Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific product.
12+
# - Scripted Connector: If the Catalog item is a DataMiner scripted connector.
13+
# - 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.
14+
# - System Health: If the Catalog item is intended to monitor the health of a system.
15+
# - User-Defined API: If the Catalog item is a DataMiner Automation script designed as a user-defined API.
16+
# - Visual Overview: If the Catalog item is a Microsoft Visio design.
17+
18+
type: 'DevTool'
19+
20+
# [Required]
21+
# The ID of the Catalog item.
22+
# All registered versions for the same ID are shown together in the Catalog.
23+
# This ID can not be changed.
24+
# If the ID is not filled in, the registration will fail with HTTP status code 500.
25+
# If the ID is filled in but does not exist yet, a new Catalog item will be registered with this ID.
26+
# If the ID is filled in but does exist, properties of the item will be overwritten.
27+
# Must be a valid GUID.
28+
id: '95a6c64b-42e8-4b01-b154-c55fe2c0750f'
29+
30+
# [Required]
31+
# The human-friendly name of the Catalog item.
32+
# Can be changed at any time.
33+
# Max length: 100 characters.
34+
# Cannot contain newlines.
35+
# Cannot contain leading or trailing whitespace characters.
36+
title: 'SkylineCommunications_Low-Code-App-Editor'
37+
38+
# [Optional]
39+
# General information about the Catalog item.
40+
# Max length: 100,000 characters
41+
# Currently not shown in the Catalog UI but will be supported in the near future.
42+
short_description: 'An interactive Automation script to export, and do some general edits to the low-code apps of a DataMiner System.'
43+
44+
# [Optional]
45+
# A valid URL that points to the source code.
46+
# A valid URL
47+
# Max length: 2048 characters
48+
source_code_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor'
49+
50+
# [Optional]
51+
# A valid URL that points to documentation.
52+
# A valid URL
53+
# Max length: 2048 characters
54+
# Currently not shown in the Catalog UI but will be supported in the near future.
55+
documentation_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor/blob/main/Documentation/README.md'
56+
57+
# [Optional]
58+
# People who are responsible for this Catalog item. Might be developers, but this is not required.
59+
# Format: 'name <email> (url)'
60+
# The name is required; max 256 characters.
61+
# The email and url are optional, and should be in valid email/URL formats.
62+
owners:
63+
- name: 'Arne Maes'
64+
email: 'arne.maes@skyline.be'
65+
url: 'https://github.com/ArneMaes0'
66+
67+
# [Optional]
68+
# Tags that allow you to categorize your Catalog items.
69+
# Max number of tags: 5
70+
# Max length: 50 characters.
71+
# Cannot contain newlines.
72+
# Cannot contain leading or trailing whitespace characters.
73+
tags:
74+
- 'Generic'
75+
- 'Tool'
76+
- 'Automation Script'
77+
- 'Low-Code App'
78+
- 'LCA'
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# SkylineCommunications_Low-Code-App-Editor
2+
3+
[![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)
4+
5+
> [!CAUTION]
6+
> This item is here for registration purposes only and should not be deployed on it's own!
7+
> 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 commit comments

Comments
 (0)