Skip to content

chore: rename server to api#7342

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
chore-rename-server-api
Jul 4, 2025
Merged

chore: rename server to api#7342
sriramveeraghanta merged 1 commit intopreviewfrom
chore-rename-server-api

Conversation

@sriramveeraghanta
Copy link
Member

@sriramveeraghanta sriramveeraghanta commented Jul 4, 2025

Type of Change

  • Code refactoring

Summary by CodeRabbit

  • Documentation

    • Updated documentation to reference the backend Django project location as apps/api instead of apps/server.
  • Chores

    • Updated workflow and Dockerfile configurations to use apps/api as the backend directory instead of apps/server.
    • Renamed related job and references in the build workflow for consistency.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

Walkthrough

The changes update references from apps/server to apps/api across the GitHub Actions workflow, Dockerfile, and documentation. The workflow job name and its parameters are updated accordingly, and the Dockerfile now copies files from the new directory. Documentation is revised to reflect the new backend path.

Changes

File(s) Change Summary
.github/workflows/build-branch.yml Renamed job and updated all references from branch_build_push_apiserver to branch_build_push_api; changed build context and Dockerfile path from apps/server to apps/api.
aio/Dockerfile-app Updated all source copy paths from apps/server/ to apps/api/ for application files.
CONTRIBUTING.md Corrected backend Django project directory from apps/server to apps/api.

Possibly related PRs

Poem

In the warren, paths have changed,
From server to api, all rearranged.
Workflows and docs now point anew,
Docker builds follow the rabbit too!
🐇 With every hop, the code stays spry—
Here’s to clean trails and servers that fly!


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sriramveeraghanta sriramveeraghanta merged commit fdbe4c2 into preview Jul 4, 2025
4 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the chore-rename-server-api branch July 4, 2025 10:02
Copy link
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: 0

🧹 Nitpick comments (2)
CONTRIBUTING.md (1)

49-52: Polish wording & apply Markdown code-style to the path

Minor copy edit will read better and keeps the path visually distinct:

-The backend is a django project which is kept inside apps/api
+The backend is a **Django** project located in `apps/api`.
aio/Dockerfile-app (1)

70-85: Parametrize duplicated apps/api path to avoid future churn

apps/api now appears five times in this block. If the directory moves again we’ll repeat this PR. Consider introducing a build-arg and re-using it:

 ARG PYTHONDONTWRITEBYTECODE=1
 ARG PYTHONUNBUFFERED=1
 ARG PIP_DISABLE_PIP_VERSION_CHECK=1 
+# location of django source inside the monorepo
+ARG API_SRC_PATH=apps/api
 
-COPY apps/api/requirements.txt ./api/
-COPY apps/api/requirements ./api/requirements
+COPY ${API_SRC_PATH}/requirements.txt ./api/
+COPY ${API_SRC_PATH}/requirements ./api/requirements
 ...
-COPY apps/api/manage.py ./api/manage.py
-COPY apps/api/plane ./api/plane/
-COPY apps/api/templates ./api/templates/
 ...
-COPY apps/api/bin ./api/bin/
+COPY ${API_SRC_PATH}/manage.py ./api/manage.py
+COPY ${API_SRC_PATH}/plane ./api/plane/
+COPY ${API_SRC_PATH}/templates ./api/templates/
+COPY ${API_SRC_PATH}/bin ./api/bin/

This reduces duplication and makes renames a one-liner.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6bee97e and fb3bda7.

📒 Files selected for processing (3)
  • .github/workflows/build-branch.yml (3 hunks)
  • CONTRIBUTING.md (1 hunks)
  • aio/Dockerfile-app (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
aio/Dockerfile-app (1)

70-85: Confirmed no stale apps/server COPYs remain in aio/Dockerfile-app
Ran rg --line-number 'apps/server' aio/Dockerfile-app and found no matches.

.github/workflows/build-branch.yml (2)

223-225: .github/workflows/build-branch.yml – Dockerfile path verified

The file apps/api/Dockerfile.api exists in the branch, so the build step will not fail due to a missing Dockerfile. No additional pre-merge check is required here.


208-229: All stray branch_build_push_apiserver references removed

I ran a repository‐wide search and confirmed there are zero occurrences of the old job identifier. No further changes are needed here.

lifeiscontent pushed a commit that referenced this pull request Aug 18, 2025
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.

2 participants