Release v1.0.1

This tool facilitates CI/CD workflows by automating the generation and updating of a catalog.yml file based on GitHub repository metadata. Here’s what’s new in this release:

Key Features

• Automatic Metadata Extraction: Pulls essential metadata (description, tags, source code URL) from a GitHub repository to populate and update catalog.yml seamlessly.
• Artifact Type Inference: Determines the artifact type based on repository naming conventions or GitHub topics, supporting multiple artifact types for streamlined catalog integration.
• Catalog YAML Auto-Generation: Creates an auto-generated-catalog.yml to track unique IDs and ensure consistent catalog records without duplication across workflow runs.

Enhancements

• Workflow Automation Support: Integrates into GitHub Actions workflows for smooth automation. See example workflows in our documentation to quickly set up.
• Improved Error Handling: Enhanced error messages and logging for debugging, especially in cases of type inference failures, ensuring faster troubleshooting.

Installation & Usage

To install:

dotnet tool install -g Skyline.DataMiner.CICD.Tools.GitHubToCatalogYaml

Run the tool with:

github-to-catalog-yaml --workspace "/path/to/workspace" --github-token "your_token" --github-repository "owner/repo"

For more detailed documentation, visit our GitHub repository and see the usage examples included.

pre-release v1.0.1-beta10

Support for name changes in catalog types, github types and github abbreviations to select types.

pre-release v1.0.1-beta9

Removes the type from the tags sent to catalog API.

pre-release v1.0.1-beta8

Adding source code url to the generated catalog.yml

pre-release v1.0.1-beta7

Continued issues with access rights on github workflows.

prerelease v1.0.1-beta6

GitHub issues with Access Rights on editing a cloned file.
Instead of editing. We now first remove the existing file.

pre-release v1.0.1-beta5

Access Rights in GitHub workflows are restricting writes to the files directly under the root.
Known 'issue' in GitHub. Code added to allow such writes.

pre-release v1.0.1-beta4

Added the ability to create the .GitHubToCatalogYaml directory if it does not exist.

pre-release 1.0.1-beta3

Access to Actions and Variables has been completely removed. A new file has been created: .GitHubToCatalogYaml/auto-generated-catalog.yml.

The purpose of this file is to commit and push it, allowing the pipeline to auto-generate a new catalog GUID if none is provided. This enables users to simply create a solution and push it without needing to manually handle catalog GUIDs.

pre-release v1.0.1-beta2

The GITHUB_TOKEN has insufficient permissions in workflows to access certain parts of the GitHub UI, specifically Actions and Variables. To address this, I’ve added an optional argument that allows the catalog identifier to be provided directly. This enables the workflow to retrieve it through alternative methods.