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.

Sign up for GitHub

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

Jump to bottom

Automated tagging/release workflow, including the JSON schema file #124

Merged
merged 2 commits into from
Jun 24, 2024
Merged

Automated tagging/release workflow, including the JSON schema file #124

merged 2 commits into from
Jun 24, 2024
+83 −1

Commits on Jun 24, 2024

  1. Workflows: Add automated Release of JSON schema 

    This adds a GitHub action that implements automated deployment (to the
GitHub Releases section) for the JSON schema file.

It is deployed to the release section because some projects want to
depend on the file as a specification of the IFEX Core IDL.

But since the JSON schema is a generated artifact based on the internal
model defined in the source code (ifex_ast.py), it should not be
committed to the source code repository, since there can be a risk of
mismatch.  Therefore it is generated.

Note: It is set up to create a release, and a tag, by inserting
a line like this in the commit:

Signed-off-by: Gunnar Andersson <[email protected]>
    @gunnar-mb
    gunnar-mb committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    41d76ae View commit details
    Browse the repository at this point in the history

  2. JSON schema generation: Add a description/version field 

    Custom fields are allowed in the json schema but here we use the
semi-standard description field.  We don't intend to repeat a long
description of what IFEX Core IDL is here, but it can be used to
indicate the schema version, which is defined using the release tag.

It will be placed there by replacing TAG-PLACEHOLDER in CI.

RELEASE-TAG: spec_v1.3

Signed-off-by: Gunnar Andersson <[email protected]>
    @gunnar-mb
    gunnar-mb committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    4d1eb88 View commit details
    Browse the repository at this point in the history