jr-1991 / generate-sdrdm-api

🤖 - GitHub Action to generate and update Python API's based on an sdRDM markdown schema

Software-driven RDM Python API Generator Action

This is a GitHub Action that generates Python API's from sdRDM markdown schemes and pushes them to the repository.

Note: If you want changes to be pushed to your repository, you need to grant action read and write access. This can be done in the settings/actions tab of your repository.

Usage

# Generates API and pushes it to the root of the repository
- name: Generate sdRDM library
  uses: JR-1991/generate-sdrdm-api@main
  with:
    library_name: "MyLibraryName"
    schema_path: "./path/to/schema"

# Generates API and pushes it to the specified directory
- name: Generate sdRDM library
  uses: JR-1991/generate-sdrdm-api@main
  with:
    library_name: "MyLibraryName"
    schema_path: "./path/to/schema"
    out_dir: "./other/dir"

# Generates API and does not push it to the repository
- name: Generate sdRDM library
  uses: JR-1991/generate-sdrdm-api@main
  with:
    library_name: "MyLibraryName"
    schema_path: "./path/to/schema"
    push: "false"

Inputs

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
branch	string	true	"main"	The sdRDM branch to be used for the generated API.
library_name	string	true		The name of the library to be generated.
out_dir	string	true	"./"	Target directory for the generated API.
push	string	true	"true"	Push the generated API to the specified branch.
schema	string	true	"false"	Generate the sdRDM schema.
schema_out_dir	string	true	"./"	Target directory for the generated schema.
schema_path	string	true	"./specifications/"	Path to the sdRDM schema.

generate-sdrdm-api's Issues

Output path variable in example different from specification

In the example to this action, the output path variable is given as output_path: "./other/dir". According to the specification, however, it should be out_dir.