feat(log-collector): adds release setup and readme docs#1714
Conversation
|
Warning Rate limit exceeded@ygrishajev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 59 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (5)
WalkthroughThis change introduces automated release and Docker build workflows for the "log-collector" app. It updates existing release automation scripts to support this app, adds a dedicated workflow for its release and Docker image build, and provides a new README and npm release script for the app. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant GitHub Actions
participant Docker Registry
Developer->>GitHub Actions: Push changes to apps/log-collector/package.json on main
GitHub Actions->>GitHub Actions: Run log-collector-release.yml
GitHub Actions->>GitHub Actions: Create release (reusable workflow)
GitHub Actions->>GitHub Actions: Build Docker image (if release created)
GitHub Actions->>Docker Registry: Push Docker image with git_tag
Estimated code review effort2 (~15 minutes) Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
ygrishajev
force-pushed
the
feat/log-collector
branch
from
c0aba83 to
feee385
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #1714 +/- ##
==========================================
- Coverage 72.41% 72.40% -0.02%
==========================================
Files 607 607
Lines 14160 14160
Branches 2405 2405
==========================================
- Hits 10254 10252 -2
+ Misses 3598 3588 -10
- Partials 308 320 +12
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
.github/workflows/create-pre-release-pr.yml (1)
90-90: Release step added correctly – keep the list sorted for sanityThe new
log-collectorrelease invocation mirrors the existing pattern and should work.
Minor nit: maintain alphabetical order to ease scanning (log-collectorshould appear afternotificationsbut beforestats-webif you keep strict ordering). Not critical, just readability.apps/log-collector/package.json (1)
42-43: Redundant wildcard-version internal depWild-carding
"@akashnetwork/releaser": "*"pins nothing and can lead to non-reproducible builds. Prefer an explicit semver range (^), or rely on the root workspace version instead of duplicating here.apps/log-collector/README.md (2)
13-16: Specify language for fenced block to satisfy markdown-lint
MD040complaints – addtext(orbash) after the triple back-ticks.-``` +```text ghcr.io/akash-network/log-collector--- `161-166`: **Typo in docker flag** `-env-file` → `--env-file` ```diff -docker run -env-file apps/log-collector/.env.local log-collector:local +docker run --env-file apps/log-collector/.env.local log-collector:local
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (5)
.github/workflows/create-pre-release-pr.yml(1 hunks).github/workflows/log-collector-release.yml(1 hunks).github/workflows/reusable-create-github-release.yml(1 hunks)apps/log-collector/README.md(1 hunks)apps/log-collector/package.json(2 hunks)
🪛 markdownlint-cli2 (0.17.2)
apps/log-collector/README.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
apps/log-collector/README.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ 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). (6)
- GitHub Check: validate / validate-app
- GitHub Check: test-build
- GitHub Check: validate / validate-app
- GitHub Check: test-build
- GitHub Check: validate / validate-app
- GitHub Check: test-build
🔇 Additional comments (2)
apps/log-collector/package.json (1)
23-24: Missingrelease-itdependency may break the release script
"release": "release-it"assumesrelease-itis available in the workspace.
@akashnetwork/releasermay wrap it, but nothing here (or in root?) guarantees that a binary namedrelease-itis on the PATH when the per-package script runs (npm run release -w apps/log-collector).Add an explicit devDependency, or change the script to invoke the wrapper provided by
@akashnetwork/releaser."devDependencies": { + "release-it": "^16.1.0",.github/workflows/reusable-create-github-release.yml (1)
63-65: Good – new tag branch added
log-collector/v<version>branch follows the existing convention. No issues spotted.
ygrishajev
force-pushed
the
feat/log-collector
branch
from
feee385 to
f24a565
Compare
ygrishajev
force-pushed
the
feat/log-collector
branch
from
f24a565 to
6ed102a
Compare
2 participants
Summary by CodeRabbit
New Features
Documentation