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

API Versioning #14

Open
that-hatter opened this issue Jan 27, 2024 · 0 comments
Open

API Versioning #14

that-hatter opened this issue Jan 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@that-hatter
Copy link
Member

The scripting API doesn't follow a versioning spec like semver. Instead, functions and constants are added/modified/deleted as needed and pushed to the live updates repo.

One possible way to track versions is to add a permalink to the commit where an entry is added/deleted/modified. Functions and constants currently have an unused since property in their status property which could be used to store the link (this was the original plan but was not implemented for now). The link would not need to be updated every time there is a change in the source code, only when the entry's status changes (stable, deprecated, deleted, unstable).

@that-hatter that-hatter added the enhancement New feature or request label Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant