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

release notes and semversion #39

Open
ivanitskiy opened this issue Aug 30, 2023 · 0 comments
Open

release notes and semversion #39

ivanitskiy opened this issue Aug 30, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@ivanitskiy
Copy link
Contributor

Is your feature request related to a problem? Please describe

In order to simplify usage and report potential issues for the njs-acme project we need to publish versions and releases periodically when have changes worth releasing (new features, bug-fix, incompatible changes, etc.).

Describe the solution you'd like

We should follow the semantic version (reminder: <breaking change>.<backward-compatible>.<minor-or-bugfix>) and make releases

Follow simple steps:

  • For a set of changes, we use tags and create a GH release where a "compiled" version of njs-acme as single a JS file can be found.
  • Document which NJS version is tested and compatible against NGINX NJS in the readme.
  • Maintain a changelog file
  • Optionally, create a docker image with a semantic version tag of njs-acme release and publish (docker hub or GH registry TBD later)
  • Optionally, publish to NPM
@ivanitskiy ivanitskiy added the enhancement New feature or request label Aug 30, 2023
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