Developer Tips

Tracing

To add tracing to all requests you should write in browser console:

localStorage.enable_tracing_for_all_requests = "true"

It will add X-Want-Trace: 1 header to all requests. Tracing data will be in Traceresponse response header

Making a hotfix version

Instruction if you don't want to merge common release from the main branch, but want to make a hotfix to a current tag.

Possible scenario: you have a big release with many changes in the main branch, but you want to make a new tag and npm package with some little fix.

1. Select a tag you want to add hotfix to:

git checkout v6.30.0

2. Create new branch from this tag. Name the branch with following pattern: hotfix/<tag-name>, otherwise release-please workflow won't see your branch

git checkout -b hotfix/v6.30.0

3. Cherry pick needed commits from the main branch or create new commits. Name new commits according to conventional commits so they appear in the hotfix changelog
4. Create commit with correct release tag in release-please-config.json. Name release tag with following pattern: <tag-name>-hotfix.<hotfix-number>

{
  // Some general settings
  "packages": {
    ".": {
      "release-as": "6.30.0-hotfix.1" // The string you need to add
    }
  }
}

5. Push branch to origin. Release PR will be created automatically
6. Merge release PR, new tag and npm package version will be created

Refresh Embedded UI inside YDB

Workflow: https://github.com/ydb-platform/ydb/blob/main/.github/workflows/embedded_ui_refresh.yaml

1. Go to ydb-platform/ydb
2. Go to Actions tab and select Embedded UI Refresh workflow
3. Click run workflow button
4. Fill ydb branch and UI release tag
5. Run workflow, it will create update PR
6. Request review from ui-backend team
7. Merge PR when it is approved

⚠️ Workflow works only with one branch at a time, if you want to update UI in several ydb branches, run workflow for another branch only after update PR is merged.

Check UI version inside YDB

If you have running ydb, you can check version in Embedded UI in Settings -> About

To check UI version inside some ydb tag without running ydb, look at the last UI update commit.

1. Go to https://github.com/ydb-platform/ydb/tree/main/ydb/core/viewer/monitoring
2. Select ydb release branch
3. Check UI version in the last update commit, it will be named in format build: refresh Embedded UI (vN.N.N)