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

chore: update github actions #1646

Merged
merged 2 commits into from
Mar 18, 2024
Merged

chore: update github actions #1646

merged 2 commits into from
Mar 18, 2024

Conversation

MoumitaM
Copy link
Contributor

@MoumitaM MoumitaM commented Mar 18, 2024

PR Description

  • Change the github runner for deploy npm workflow
  • Updated github release workflow
  • Updated deploy to staging workflow

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • Chores
    • Updated the deployment process to use the latest Ubuntu version for NPM publishing.
    • Modified environment variables and conditional logic in staging deployment for improved reliability.
    • Enhanced the release publishing workflow by refining the versioning logic.

@MoumitaM MoumitaM requested a review from saikumarrs as a code owner March 18, 2024 10:26
Copy link
Contributor

coderabbitai bot commented Mar 18, 2024

Walkthrough

The recent modifications streamline the deployment and release processes by refining execution environments, enhancing variable handling, and refining conditional logic. These adjustments ensure smoother operations across different stages of the development pipeline, from staging deployments to NPM publishing and new release management, reflecting a meticulous approach to improving workflow efficiency and reliability.

Changes

Files Change Summary
.github/workflows/deploy-npm.yml Updated runs-on configuration in deploy-tag job to ubuntu-latest for NPM publishing restrictions.
.github/workflows/deploy-staging.yml Updated NODE_OPTIONS environment variable to use single quotes; modified conditional logic for workflow execution to include github.head_ref alongside github.ref.
.github/workflows/.../new-release.yml Updated the VERSION variable assignment using BRANCH_NAME, modifying extraction logic to remove prefixes.

🐇✨
In the realm of code, under digital skies,
Changes unfold with a hop and a surprise.
From Ubuntu's embrace to the single quote dance,
Each file, each line, in harmonious stance.
Through branches and tags, our updates shall weave,
A tapestry of code, in which we believe.
🌟🐾

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@MoumitaM MoumitaM merged commit 7792d3c into develop Mar 18, 2024
9 checks passed
@MoumitaM MoumitaM deleted the fix-github-actions branch March 18, 2024 10:28
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a269da6 and 6d05f32.
Files selected for processing (3)
  • .github/workflows/deploy-npm.yml (1 hunks)
  • .github/workflows/deploy-staging.yml (1 hunks)
  • .github/workflows/publish-new-release.yml (2 hunks)
Additional comments: 6
.github/workflows/publish-new-release.yml (2)
  • 11-11: The NODE_OPTIONS environment variable is set globally for the workflow. Ensure that the --no-warnings flag does not suppress important warnings that could indicate issues during the release process.
  • 27-27: The logic for stripping prefixes from BRANCH_NAME to assign to VERSION is a significant change. This approach simplifies version management, especially for hotfixes and releases. However, ensure that this logic aligns with the project's versioning strategy and that it does not inadvertently affect version naming conventions or comparisons elsewhere in the project.
.github/workflows/deploy-staging.yml (2)
  • 17-17: The update to the NODE_OPTIONS environment variable from double to single quotes is a minor change that should not affect functionality. However, it's good practice to ensure consistency in the use of quotes throughout your workflow files.
  • 25-25: The modification to include github.head_ref in the conditional logic for triggering the workflow is a thoughtful addition. It enhances the flexibility of the workflow by allowing it to be triggered under more specific conditions. Ensure that this change aligns with the project's deployment strategy and that it does not inadvertently trigger unwanted deployments.
.github/workflows/deploy-npm.yml (2)
  • 15-15: The NODE_OPTIONS environment variable is set globally for the workflow. As with the other workflows, ensure that the --no-warnings flag does not suppress important warnings that could indicate issues during the deployment process.
  • 20-20: The update to use ubuntu-latest instead of a self-hosted runner for the deploy-tag job aligns with NPM publishing restrictions and is a move towards standardization. Ensure that this change does not introduce any compatibility issues with the project's deployment scripts or dependencies that were previously tailored to the self-hosted runner environment.
Verification successful

Given the nature of the task and the limitations of automated verification, a more thorough manual review of the deployment scripts and dependencies is recommended to ensure there are no compatibility issues with the switch to ubuntu-latest. This review should focus on identifying any configurations or dependencies that were specifically tailored to the self-hosted runner environment and verifying their compatibility with ubuntu-latest.


Based on the information provided and the analysis of the script outputs, there is no direct evidence to suggest that the switch to ubuntu-latest from a self-hosted runner introduces compatibility issues with the project's deployment scripts or dependencies. The references found are primarily within documentation and node modules, which do not directly imply any compatibility concerns. Therefore, it appears that the update aligns with NPM publishing restrictions and is unlikely to cause issues related to the project's deployment process on ubuntu-latest.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that the switch to `ubuntu-latest` does not introduce compatibility issues.
# This script is a placeholder for the actual verification process, which should be conducted manually or through additional automated checks.
echo "Manual verification needed to ensure no compatibility issues with `ubuntu-latest`."

Length of output: 242



Script:

#!/bin/bash
# Search for deployment scripts or configurations that might be tailored to a self-hosted runner environment.
fd --type f --exec grep -E 'self-hosted|runner|deployment' {}

Length of output: 11001

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.81 KB 15.81 KB (0%) 16.5 KB
Remote Module Federation Mapping - CDN 330 B 330 B (0%) 512 B
Remote Module Federated Plugins - CDN 5.71 KB 5.71 KB (0%) 6 KB
Core ESM - NPM 7.64 KB 7.64 KB (0%) 8 KB
Core CJS - NPM 22.43 KB 22.43 KB (0%) 23 KB
Core - NPM 22.57 KB 22.57 KB (0%) 23 KB
Core Legacy - CDN 42.9 KB 42.9 KB (0%) 44 KB
Core - CDN 22.72 KB 22.72 KB (0%) 23 KB
Core (legacy build) - CDN - v1.1 31.54 KB 31.54 KB (0%) 32 KB
Core - NPM - v1.1 31.52 KB 31.52 KB (0%) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.57 KB 98.57 KB (0%) 105 KB

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