v3.1

What's Changed

• Set default version to recent PyPI instead of main branch by @JR-1991 in #8

Full Changelog: v3...v3.1

v3

• Changed target branch from linking-refactor to main

Full Changelog: v2...v3

v2

What's Changed

• Fixes in default specifications path and example by @torogi94 in #5

New Contributors

• @torogi94 made their first contribution in #5

Full Changelog: v1...v2

v1

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"
    output_path: "./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	"linking-refactor"	The sdRDM branch to be used for the generated API.
library_name	string	true	"unstable"	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	"./specifcations/"	Path to the sdRDM schema.