Skip to content

feat: initial job property validation docs#915

Open
achrinza wants to merge 2 commits into
cloudfoundry:masterfrom
achrinzafork:feat/property-validation
Open

feat: initial job property validation docs#915
achrinza wants to merge 2 commits into
cloudfoundry:masterfrom
achrinzafork:feat/property-validation

Conversation

@achrinza

Copy link
Copy Markdown
Contributor

Document BOSH release job property validation

see: cloudfoundry/community#1049
see: cloudfoundry/bosh-cli#681
see: cloudfoundry/bosh#2602

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9c7e34b6-25aa-4a9d-898d-ba0ba131d5ee

📥 Commits

Reviewing files that changed from the base of the PR and between cc69f46 and 57ca4c9.

📒 Files selected for processing (1)
  • content/jobs.md

Walkthrough

Updates the job specification documentation by adding a title annotation to the YAML example. Replaces the previous property-field explanation with a property validation section covering BOSH version requirements, bosh create-env behavior, per-job properties_schema.json files, JSON Schema examples, the custom certificate type, and the schema’s validation-only scope.

Suggested reviewers: neddp, selzoc, bgandon, dpb587-pivotal, h4xnoodle

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding initial documentation for job property validation.
Description check ✅ Passed The description is directly related to the docs update and references the relevant BOSH property validation work.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 2

🤖 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 `@content/jobs.md`:
- Around line 111-112: Insert a blank line between the `---` separator and the
`## Property validation` heading in the property-validation section, preserving
the heading and separator unchanged.
- Around line 132-139: Update the trusted_certificate property in
properties-schema.json to use the valid JSON Schema type "string" instead of
"certificate"; preserve any certificate-specific requirements through separate
validation or description metadata.
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4fbd9741-2a4a-4ea1-b892-432454065c91

📥 Commits

Reviewing files that changed from the base of the PR and between 31eab35 and 0feabf3.

📒 Files selected for processing (1)
  • content/jobs.md

Comment thread content/jobs.md
Comment thread content/jobs.md Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 12, 2026
@github-project-automation github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jul 12, 2026
@github-project-automation github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jul 12, 2026
@achrinza
achrinza force-pushed the feat/property-validation branch 4 times, most recently from 5fc610d to afcdff8 Compare July 13, 2026 06:17
Document BOSH release job property validation

see: cloudfoundry/community#1049
see: cloudfoundry/bosh-cli#681
see: cloudfoundry/bosh#2602
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
@achrinza
achrinza force-pushed the feat/property-validation branch from afcdff8 to cc69f46 Compare July 13, 2026 06:17
@achrinza

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 13, 2026
aramprice
aramprice previously approved these changes Jul 13, 2026

@aramprice aramprice left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, thank you for the additions. I ran copilot, feel free to resolve any comments that aren't helpful.

Copilot AI left a comment

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.

Pull request overview

Documents BOSH release job property validation by introducing a new “Property validation” section in the release jobs documentation, including version requirements and example JSON Schemas.

Changes:

  • Adds a dedicated “Property validation” section describing how job properties can be validated via JSON Schema.
  • Includes example schema files and a BOSH-specific JSON Schema certificate type extension.
  • Improves/clarifies existing wording around job spec property keys and validation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/jobs.md Outdated
Comment thread content/jobs.md Outdated
Comment thread content/jobs.md Outdated
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
@achrinza
achrinza dismissed stale reviews from aramprice and coderabbitai[bot] via 57ca4c9 July 13, 2026 16:24
@aramprice aramprice moved this from Pending Merge | Prioritized to Waiting for Changes | Open for Contribution in Foundational Infrastructure Working Group Jul 16, 2026
@aramprice

Copy link
Copy Markdown
Member

@achrinza - could you rebase this, there appear to be conflicts. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Waiting for Changes | Open for Contribution

Development

Successfully merging this pull request may close these issues.

3 participants