credential-registry-publish-action

A GitHub action that may be used to push linked open data that an organization offers on their own website in CTDL format to the Credential Registry by Credential Engine.

Documentation and Examples: Get detailed information about how to publish your CTDL-formatted linked open data and how to configure this action to publish your data to the Registry.

This tool enables organizations to publish a wide variety of open data about their credentials, learning opportunities, and more, so that it can be accessible both on organizational websites and discoverable in the Credential Engine Registry via CredentialFinder.org.

This tool is intended for developers or other technical staff, probably by those implementing the open data publishing strategy. Other methods of publishing data to the Registry are available for non-developers, including input forms and CSV uploads on the Credential Engine website.

Get assistance and report problems

Reach out to Credential Engine staff via email if you need help using the tool. To report issues, you can use email or file them on GitHub at the credential-registry-publish-action repository. This software is open source and open for contributions and improvements.

Developer and Contributor Notes

Contributions to this effort are welcome via pull request on GitHub. Please file issues and coordinate with the Credential Engine team via email or GitHub issues if you have questions.

This repository contains one GitHub Action using a NodeJS runtime. It roughly follows the approach at Creating a JavaScript Action except that it uses a TypeScript source, compiled to JavaScript with ncc. Contributors, see some additional documentation on using the Actions Toolkit in Typescript, covering how to use test mocks.

A compiled version of the action is committed to the repository, so that it can be used by GitHub actions. You can run the code locally with npm run local with input variables set in a .env file. See the .env.example file for the variables that are required, matching the inputs of the GitHub Action.

The library dynamically loads CTDL schema data from the Credential Engine website on postinstall. If you need to regenerate the downloaded schema to account for occasional updates, run npm run buildSchema. Run npm run build to generate the compiled artifact before submitting your pull request.