Skip to content

Commit

Permalink
docs: add RELEASE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexey Zorkaltsev authored and Alexey Zorkaltsev committed Sep 1, 2023
1 parent 129b828 commit 48199e0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 14 deletions.
14 changes: 0 additions & 14 deletions .github/workflows/release-debug.yml

This file was deleted.

4 changes: 4 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@ The following authors have created the source code of "Yandex Database Node.js S
published and distributed by YANDEX LLC as the owner:

Timur Sufiev <[email protected]>

Current maintainer:

Alexey Zorkaltsev <[email protected]>
19 changes: 19 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# The process of release a new version of the SDK

All commits to the project have to follow to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)

The github action https://github.com/gravity-ui/release-action is used for releases.

In short, for any commit with *feat:* and *bug:* prefixes, a release PR is created and subsequent commits are added to it.
To release a version to npm, a release PR must be accepted.

If you have questions about releases, you can ask them in the [Data UI: Open Source group](https://t.me/+mB1K40iDo0hmYTU6).

To run releases, you need to have admin rights in the github project.

Secrets required for release are stored in YDB_PLATFORM_BOT_TOKEN_REPO and NODE_AUTH_TOKEN variables. And can be
altered by github project admin.

**Important**: After performing a release, you should check that the new version has appeared in npm. If the version
has not been updated, then to repeat the release you need to make a new commit without changing code with
*bug: npm update* subject and repeat the release.

0 comments on commit 48199e0

Please sign in to comment.