Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Resource.v1alpha1.schema.json #8

Merged
merged 2 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# validate-catalog-info

This action validates the contents of a `catalog-info.yml` file. This action can be used during CI or other workflows to ensure the ongoing validity of the file.
This action validates the contents of a `catalog-info.yml` file. This action can be used during CI or other workflows to ensure the ongoing validity of the file.

The action uses the files defined in the [schema] directory for validation.

> [!NOTE]
> The action does require the `catalog-info.yml` file to exist on disk prior to running this validation action.
The action creates [error annotations] for every validation error it finds and a [warning annotation] for each invalid yaml document inside the `catalog-info.yml`. GitHub has [annotation limits] of 10 error and 10 warning annotations per step though, so only 10 errors and 10 warnings will can be shown on the `catalog-info.yml` file or on the workflow summary. The workflow log still shows all errors.
The action creates [error annotations] for every validation error it finds and a [warning annotation] for each invalid yaml document inside the `catalog-info.yml`. GitHub has [annotation limits] of 10 error and 10 warning annotations per step though, so only 10 errors and 10 warnings will can be shown on the `catalog-info.yml` file or on the workflow summary. The workflow log still shows all errors.

To address the limitation with the number of annotations, an `errors-markdown` output is available with the generated markdown for all errors detected in the file. A job summary is created automatically with the same markdown unless `generate-job-summary` is set to `false`.

Expand Down Expand Up @@ -54,7 +54,7 @@ jobs:

- name: Validate catalog-info.yml
id: catalogInfo
uses: im-open/[email protected].4
uses: im-open/[email protected].5
with:
filename: ./docs/catalog-info.yml # Defaults to ./catalog-info.yml
fail-if-errors: false # Defaults to true
Expand Down Expand Up @@ -93,7 +93,7 @@ This repo uses [git-version-lite] in its workflows to examine commit messages to

### Source Code Changes

The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows.
The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows.

If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The [build-and-review-pr] workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.

Expand Down
2 changes: 1 addition & 1 deletion dist/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -29548,7 +29548,7 @@ var require_Resource_v1alpha1_schema = __commonJS({
$id: 'Resource.v1alpha1.schema.json',
$comment: 'Based, with some modification & customization, on https://json.schemastore.org/catalog-info.json.',
description:
"Resources are those things that aren't components themselves, but are either needed by components or augment components to help them function. Some examples include the ExtendHealth Database, the App Gateway, Resource Groups, and fileshares.\r\rIf a Resource has multiple instances, such as is the case for the internal App Gateway, they should be recorded in the metadata.instances property.\r\rMore info @ https://techhub.mktp.io/docs/default/system/techhub/catalog-info-entities/resource/ .",
"Resources are those things that aren't components themselves, but are either needed by components or augment components to help them function. Some examples include the ExtendHealth Database, the App Gateway, Resource Groups, and fileshares.\r\rMore info @ https://techhub.mktp.io/docs/default/system/techhub/catalog-info-entities/resource/ .",
examples: [
{
apiVersion: 'backstage.io/v1alpha1',
Expand Down
2 changes: 1 addition & 1 deletion schema/Resource.v1alpha1.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "Resource.v1alpha1.schema.json",
"$comment": "Based, with some modification & customization, on https://json.schemastore.org/catalog-info.json.",
"description": "Resources are those things that aren't components themselves, but are either needed by components or augment components to help them function. Some examples include the ExtendHealth Database, the App Gateway, Resource Groups, and fileshares.\r\rIf a Resource has multiple instances, such as is the case for the internal App Gateway, they should be recorded in the metadata.instances property.\r\rMore info @ https://techhub.mktp.io/docs/default/system/techhub/catalog-info-entities/resource/ .",
"description": "Resources are those things that aren't components themselves, but are either needed by components or augment components to help them function. Some examples include the ExtendHealth Database, the App Gateway, Resource Groups, and fileshares.\r\rMore info @ https://techhub.mktp.io/docs/default/system/techhub/catalog-info-entities/resource/ .",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
Expand Down
Loading