Skip to content
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.

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

Fix release pathing #2606

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Fix release pathing #2606

merged 1 commit into from
Jan 24, 2025

Conversation

nguyentvan7
Copy link
Collaborator

@nguyentvan7 nguyentvan7 commented Jan 24, 2025

Describe your changes

Issue or discord link

Testing/validation

Checklist before requesting a review (leave this PR as draft if any part of this list is not done.)

  • I have commented my code in hard-to understand areas.
  • I have made corresponding changes to README or wiki.
  • For front-end changes, I have updated the corresponding English translations.
  • I have run yarn run mini-ci locally to validate format and lint.
  • If I have added a new library or app, I have updated the deployment scripts to ignore changes as needed

Summary by CodeRabbit

  • Configuration
    • Enhanced GitHub Actions workflow with new nested_deployments parameter
    • Added flexibility to deployment process by allowing optional nested deployment configurations
    • Updated workflow to support more granular deployment strategies

Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request modifies two GitHub Actions workflow files by introducing a new boolean input parameter called nested_deployments. In the build-frontend.yml workflow, this parameter controls whether the frontend deployment will be nested in a sub-folder corresponding to the frontend_name. The workflow is updated to conditionally echo the frontend name and create an empty file. In the new-zo-release.yml workflow, the parameter is explicitly set to false when calling the build frontend job.

Changes

File Change Summary
.github/workflows/build-frontend.yml Added nested_deployments input parameter (default: true), modified frontend name handling with conditional file creation
.github/workflows/new-zo-release.yml Added nested_deployments: false to the call-build-frontend job

Possibly related PRs

Suggested reviewers

  • frzyc

Poem

🐰 Deployment's dance, a flexible tune
Nested or flat, choose your own boon
A boolean switch, so simple and bright
Workflows adapt with algorithmic might
CodeRabbit's magic, deployment's delight! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

@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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d03973c and a29279f.

📒 Files selected for processing (2)
  • .github/workflows/build-frontend.yml (2 hunks)
  • .github/workflows/new-zo-release.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: typecheck
  • GitHub Check: lint
  • GitHub Check: call-build / build
  • GitHub Check: call-build / build
  • GitHub Check: call-build / build
  • GitHub Check: test
  • GitHub Check: call-build / build
  • GitHub Check: gen-file
🔇 Additional comments (2)
.github/workflows/new-zo-release.yml (1)

15-15: LGTM! Setting nested_deployments to false is appropriate for releases.

This ensures the release is deployed to the root folder instead of being nested, which is the expected behavior for releases.

.github/workflows/build-frontend.yml (1)

27-30: LGTM! Well-documented input parameter.

The new nested_deployments parameter is clearly documented with its purpose and impact on deployment behavior.

Comment on lines +78 to +86
touch frontend_name
echo ${{inputs.deployment_name}} > deployment_name
echo ${{inputs.repo_name}} > repo_name
echo ${{inputs.repo_deploy_secret_name}} > repo_deploy_secret_name
echo $(git rev-parse HEAD) > ref
- name: echos (frontend_name)
if: inputs.nested_deployments == 'true'
run: |
echo ${{inputs.frontend_name}} > frontend_name
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Refactor the frontend_name file handling.

Several issues with the current implementation:

  1. Creating an empty file then conditionally filling it is confusing
  2. Boolean comparison uses string 'true' instead of boolean true
  3. The empty frontend_name file is still uploaded as an artifact

Consider this alternative approach:

- touch frontend_name
  echo ${{inputs.deployment_name}} > deployment_name
  echo ${{inputs.repo_name}} > repo_name
  echo ${{inputs.repo_deploy_secret_name}} > repo_deploy_secret_name
  echo $(git rev-parse HEAD) > ref
- - name: echos (frontend_name)
-   if: inputs.nested_deployments == 'true'
-   run: |
-     echo ${{inputs.frontend_name}} > frontend_name
+ if [ "${{inputs.nested_deployments}}" = true ]; then
+   echo ${{inputs.frontend_name}} > frontend_name
+ else
+   echo "" > frontend_name
+ fi

This change:

  1. Consolidates the frontend_name file handling into a single step
  2. Uses proper boolean comparison
  3. Makes the empty file creation explicit when nested_deployments is false
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
touch frontend_name
echo ${{inputs.deployment_name}} > deployment_name
echo ${{inputs.repo_name}} > repo_name
echo ${{inputs.repo_deploy_secret_name}} > repo_deploy_secret_name
echo $(git rev-parse HEAD) > ref
- name: echos (frontend_name)
if: inputs.nested_deployments == 'true'
run: |
echo ${{inputs.frontend_name}} > frontend_name
- name: Create deployment files
run: |
echo ${{inputs.deployment_name}} > deployment_name
echo ${{inputs.repo_name}} > repo_name
echo ${{inputs.repo_deploy_secret_name}} > repo_deploy_secret_name
echo $(git rev-parse HEAD) > ref
if [[ "${{inputs.nested_deployments}}" == true ]]; then
echo "${{inputs.frontend_name}}" > frontend_name
else
echo "" > frontend_name
fi

Copy link
Contributor

github-actions bot commented Jan 24, 2025

[] [Fri Jan 24 02:43:47 UTC 2025] - Deployed b115abb to https://genshin-optimizer-prs.github.io/pr/2606/ (Takes 3-5 minutes after this completes to be available)

[] [Fri Jan 24 02:45:03 UTC 2025] - Deployed b115abb to https://genshin-optimizer-prs.github.io/pr/2606/ (Takes 3-5 minutes after this completes to be available)

[Fri Jan 24 04:24:48 UTC 2025] - Deleted deployment

@nguyentvan7 nguyentvan7 merged commit e019467 into master Jan 24, 2025
10 checks passed
@nguyentvan7 nguyentvan7 deleted the van/zo/fixRelease branch January 24, 2025 04:24
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