8000 fix: sites deployment activation instructions in createDeployment by Priyanshuthapliyal2005 · Pull Request #10566 · appwrite/appwrite · GitHub
[go: up one dir, main page]
Skip to content

fix: sites deployment activation instructions in createDeployment #10566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: 1.8.x
Choose a base branch
from
Open

fix: sites deployment activation instructions in createDeployment #10566

wants to merge 3 commits into from
+17 −17

Conversation

Priyanshuthapliyal2005
Copy link
@Priyanshuthapliyal2005 Priyanshuthapliyal2005 commented Sep 30, 2025 •
edited
Loading

What does this PR do?

This pull request clarifies the deployment creation docs by stating that activation uses the site's deployment ID, not a function's deployment.

Fixes #10565

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)

verified against the generated swagger files.
image
image

Related PRs and Issues

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Sep 30, 2025 •
edited
Loading

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (8)
  • app/config/specs/open-api3-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/open-api3-latest-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-1.8.x-server.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-console.json is excluded by !app/config/specs/**
  • app/config/specs/swagger2-latest-server.json is excluded by !app/config/specs/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The change updates a description string in src/Appwrite/Platform/Modules/Sites/Http/Deployments/Create.php, replacing the phrase "your function's deployment" with "your site's deployment." No logic, behavior, or control flow modifications were made.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately describes the main change by indicating that the site deployment activation instructions in the createDeployment endpoint are being corrected, aligning directly with the single-wording update in the API method description.
Description Check ✅ Passed The pull request description clearly explains that it updates the deployment creation documentation to reference the site’s deployment ID instead of a function’s deployment and includes relevant context such as the related issue number and verification steps.

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.

@github-actions GitHub Actions
Copy link
github-actions bot commented Sep 30, 2025 •
edited
Loading

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
libexpat 2.7.1-r0 CVE-2025-59375 HIGH
golang.org/x/crypto v0.31.0 CVE-2025-22869 HIGH
golang.org/x/oauth2 v0.24.0 CVE-2025-22868 HIGH
stdlib 1.22.10 CVE-2025-47907 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

@Priyanshuthapliyal2005
Copy link
Author

@ChiragAgg5k should i need to include specs file in pr too ?

@ChiragAgg5k
Copy link
Member

@Priyanshuthapliyal2005 yeah feel free to, make sure to update both 1.8.x and latest

@ChiragAgg5k ChiragAgg5k self-assigned this Oct 1, 2025
@ChiragAgg5k
Copy link
Member

@Priyanshuthapliyal2005 command to run docker compose exec appwrite specs and docker compose exec appwrite specs --version=1.8.x

@Priyanshuthapliyal2005
Copy link
Author

@ChiragAgg5k i have added specs files

@ChiragAgg5k
Copy link
Member

@Priyanshuthapliyal2005 can you please target the 1.8.x branch of the repo? main is out of sync and we use that branch for current development

@Priyanshuthapliyal2005 Priyanshuthapliyal2005 changed the base branch from main to 1.8.x October 1, 2025 08:23
@Priyanshuthapliyal2005
Copy link
Author

@Priyanshuthapliyal2005 can you please target the 1.8.x branch of the repo? main is out of sync and we use that branch for current development

i have updated the target branch

@stnguyen90 stnguyen90 self-requested a review October 1, 2025 16:09
@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Oct 6, 2025

Open in StackBlitz

npm i https://pkg.pr.new/appwrite/appwrite/@appwrite.io/console@10566

commit: cc6f5fe

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

@loks0n loks0n loks0n approved these changes

@stnguyen90 stnguyen90 Awaiting requested review from stnguyen90

Assignees

@ChiragAgg5k ChiragAgg5k

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Misleading Reference to Deployment Activation in Sites API Documentation
3 participants
@Priyanshuthapliyal2005 @ChiragAgg5k @loks0n
0