Skip to content

FRAMENGG-13353 (docs): Add engines to sample app manifests - #21

Merged
cb-jananivijayan merged 1 commit into
mainfrom
FRAMENGG-13353-sample-engines
Aug 27, 2026
Merged

FRAMENGG-13353 (docs): Add engines to sample app manifests#21
cb-jananivijayan merged 1 commit into
mainfrom
FRAMENGG-13353-sample-engines

Conversation

@cb-nainar

@cb-nainar cb-nainar commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

CHANGELOG

Add engines.node and engines.chargebee_apps to sample app manifests.

SUMMARY

Sample apps now include the same engines object the CLI writes on create/package. Those keys are overwritten by the CLI; do not hand-edit them. Values in this repo are examples and will change when you package.

Related: FRAMENGG-13353, DOCS-9902.

FUNCTIONAL AUTOMATION CHANGES PR

  • Yes
    • If Yes, PR :
  • No
    • If No, Reason: Manifest documentation in sample apps only.

AUTOMATION TEST REPORT URL

NA

AREAS OF IMPACT

Sample app manifest.json files and README.

TYPE OF CHANGE

  • 🐞 Bugfix
  • 🌟 Feature
  • ✨ Enhancement
  • 🧪 Unit Test Cases
  • 📔 Documentation
  • ⚙️ Chore - Build Related / Configuration / Others

DOCUMENTATION

NA

Updated sample app manifests with engines.node and engines.chargebee_apps values. Documented that the CLI overwrites these example values during create and package, so users should not edit them manually.

Document that create and package overwrite Node and CLI versions; do not hand-edit those keys.
@snyk-io

snyk-io Bot commented Aug 18, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues
Secrets 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: ab818442-cc2a-47b7-9b46-41772e156a4c

📥 Commits

Reviewing files that changed from the base of the PR and between fced0b7 and 403a6b2.

📒 Files selected for processing (4)
  • README.md
  • sample-apps/sample-apps-with-iparams/crm_lead_on_customer_created_sample_app/manifest.json
  • sample-apps/sample-apps-with-iparams/schedule_advance_invoice_sample_app/manifest.json
  • sample-apps/sample-apps-without-iparams/dunning_cycle_end_handler_sample_app/manifest.json

Included review availability: Your plan includes up to 12 reviews per rolling hour; 9 remain after this review.


Walkthrough

The change adds Node.js 22.11.0 and Chargebee Apps 1.1.1 engine requirements to three sample app manifests. The README explains that the create and package commands manage these values.

Changes

Manifest engine requirements

Layer / File(s) Summary
Add and document engine requirements
sample-apps/sample-apps-with-iparams/*/manifest.json, sample-apps/sample-apps-without-iparams/*/manifest.json, README.md
Three sample app manifests now define Node.js 22.11.0 and Chargebee Apps 1.1.1. The README states that the create and package commands overwrite these values.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 403a6

This change adds engine metadata to sample app manifests and related documentation; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: cb-gaganbankey

🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

@cb-jananivijayan
cb-jananivijayan merged commit 278865f into main Aug 27, 2026
6 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.

3 participants