Skip to content

LCORE-1720: LCORE package release#1738

Merged
tisnik merged 1 commit into
lightspeed-core:mainfrom
tisnik:lcore-1720-lcore-package-release
May 14, 2026
Merged

LCORE-1720: LCORE package release#1738
tisnik merged 1 commit into
lightspeed-core:mainfrom
tisnik:lcore-1720-lcore-package-release

Conversation

@tisnik
Copy link
Copy Markdown
Contributor

@tisnik tisnik commented May 14, 2026

Description

LCORE-1720: LCORE package release

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-1720

Summary by CodeRabbit

  • Documentation
    • Added comprehensive releasing guide documenting semantic versioning, version management, package publishing to PyPI, and GitHub release procedures.
    • Updated documentation and README with new Releasing section linking to the complete release procedure guide.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 14, 2026

Warning

Rate limit exceeded

@tisnik has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 54 minutes and 10 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ab90b292-26db-4d4b-b7c1-b3bd722266ab

📥 Commits

Reviewing files that changed from the base of the PR and between a06ff62 and e956c8a.

📒 Files selected for processing (4)
  • README.md
  • docs/README.md
  • docs/index.md
  • docs/releasing.md

Walkthrough

This PR adds a comprehensive release procedure guide to the project documentation and links it throughout the README and documentation structure. The new docs/releasing.md document details semantic versioning, publishing prerequisites, version updates, Python package distribution, and GitHub release steps.

Changes

Release documentation and integration

Layer / File(s) Summary
Release procedure documentation
docs/releasing.md
Complete release guide covering semantic versioning rules, prerequisites/access requirements, version update via src/version.py, OpenAPI regeneration via make schema, PyPI publishing workflow (archive building and uploading), and GitHub release/tag procedures with README badge updates.
Documentation navigation and linking
README.md, docs/README.md, docs/index.md
Table of contents and cross-references updated to link the new Releasing guide from project README, documentation landing page, and site navigation index.

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding LCORE package release documentation and procedures.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/releasing.md`:
- Line 145: Update the tag example to match the release name RC index: change
the tag `0.6.0rc` to `0.6.0rc1` so the tag example and the release name
"Lightspeed Stack version 0.6.0rc1" are consistent.
- Line 52: Replace the incorrect TestPyPI URL string 'https://test.pypi.org/p'
in the docs/releasing.md prerequisites with the correct TestPyPI URL
'https://test.pypi.org/' so the access token instruction points to the valid
TestPyPI site.
- Around line 103-105: The markdown fenced code blocks in the docs (the blocks
containing the text "Successfully built lightspeed_stack-{version}.tar.gz and
lightspeed_stack-{version}-py3-none-any.whl", the block with the PyPI/ TestPyPI
credentials starting with "[testpypi]" and "[pypi]", and the block containing
the badge markdown
"[![Tag](https://img.shields.io/github/v/tag/lightspeed-core/lightspeed-stack)](https://github.com/lightspeed-core/lightspeed-stack/releases/tag/0.5.0)")
are missing language identifiers and trigger MD040; update each fenced block to
include an appropriate language identifier (e.g., ```text for the build output
line, ```ini for the PyPI config block, and ```markdown for the badge line) so
markdownlint passes.
- Line 66: The docs reference contains a typo in the integration test path:
change "tests/integration/endponts/test_rlsapi_v1_integration.py" to the correct
"tests/integration/endpoints/test_rlsapi_v1_integration.py" in docs/releasing.md
so links and readers point to the actual integration test file.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 48bedafa-6c31-45f4-a4dc-f3be6eafe662

📥 Commits

Reviewing files that changed from the base of the PR and between c44c728 and a06ff62.

📒 Files selected for processing (4)
  • README.md
  • docs/README.md
  • docs/index.md
  • docs/releasing.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: integration_tests (3.13)
  • GitHub Check: unit_tests (3.13)
  • GitHub Check: unit_tests (3.12)
  • GitHub Check: Pylinter
  • GitHub Check: build-pr
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
  • GitHub Check: E2E: library mode / ci / group 2
  • GitHub Check: E2E: server mode / ci / group 1
  • GitHub Check: E2E: server mode / ci / group 2
  • GitHub Check: E2E: server mode / ci / group 3
  • GitHub Check: E2E: library mode / ci / group 1
  • GitHub Check: E2E: library mode / ci / group 3
  • GitHub Check: E2E Tests for Lightspeed Evaluation job
🧰 Additional context used
🪛 LanguageTool
docs/releasing.md

[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ty in a backwards-compatible manner. * Increment PATCH when you make backwards-compatibl...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~76-~76: Consider a more concise word here.
Context: ... that is stored in docs/openapi.json. In order to do it, run the following command: ```b...

(IN_ORDER_TO_PREMIUM)


[style] ~76-~76: Consider a more expressive alternative.
Context: ...red in docs/openapi.json. In order to do it, run the following command: ```bash...

(DO_ACHIEVE)


[grammar] ~93-~93: Ensure spelling is correct
Context: ...s are deleted (the latest are hidden on Unit systems!) ### Build the distribution a...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~107-~107: Use a hyphen to join words.
Context: ...ion}-py3-none-any.whl ``` Please double check that the {version} really contai...

(QB_NEW_EN_HYPHEN)


[style] ~108-~108: Consider using a different verb to strengthen your wording.
Context: ...the correct version number. Also please make sure that the archive was really built to av...

(MAKE_SURE_ENSURE)


[grammar] ~151-~151: Ensure spelling is correct
Context: ... ### Update link in README.md At the beggining of README.md there's a line: ``` [![...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.22.1)
docs/releasing.md

[warning] 103-103: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 122-122: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 153-153: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (3)
README.md (1)

85-85: LGTM!

Also applies to: 1225-1227

docs/README.md (1)

78-80: LGTM!

docs/index.md (1)

85-87: LGTM!

Comment thread docs/releasing.md Outdated
## Prerequisites

* Access to https://github.com/lightspeed-core/lightspeed-stack as owner or maintainer
* Access token to https://pypi.org/ and/or to https://test.pypi.org/p
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix broken TestPyPI URL in prerequisites.

Line 52 uses https://test.pypi.org/p, which is not a valid destination and can mislead maintainers during release prep. Use the proper TestPyPI URL.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/releasing.md` at line 52, Replace the incorrect TestPyPI URL string
'https://test.pypi.org/p' in the docs/releasing.md prerequisites with the
correct TestPyPI URL 'https://test.pypi.org/' so the access token instruction
points to the valid TestPyPI site.

Comment thread docs/releasing.md Outdated
Comment thread docs/releasing.md Outdated
Comment thread docs/releasing.md Outdated
@tisnik tisnik force-pushed the lcore-1720-lcore-package-release branch from a06ff62 to e956c8a Compare May 14, 2026 07:23
@tisnik tisnik merged commit ce689f9 into lightspeed-core:main May 14, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant