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(release): pulling release/3.1.0 into main #1658

Closed
wants to merge 5 commits into from

Conversation

devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack devops-github-rudderstack commented Mar 21, 2024

👑 An automated PR

Summary by CodeRabbit

  • Chores
    • Restricted the use of GitHub hosted runners for NPM package publishing and adjusted Slack message naming in workflows.
    • Updated naming conventions and comments in deployment workflows for clarity.
    • Changed the runs-on configuration for publishing new releases to use ubuntu-latest.
    • Updated the version of the github-action-check-size-limit action.
    • Modified the list of directory owners in the CODEOWNERS file.
  • Documentation
    • Corrected the capitalization of "JavaScript" across various README.md files for consistency and clarity.
  • Refactor
    • Updated URLs to remove beta references in the constants file.
    • Modified the expected CDN path assertion in a test to use a variable directly.
  • Tests
    • Updated sonar.projectVersion for code quality checks.

saikumarrs and others added 5 commits March 18, 2024 16:49
… test (#1654)

* chore: default constant for plugins and integrations base url updated

* chore: updated beta path in unit test
* feat: remove beta status for all the packages

* fix: mono repo version bump

* chore: remove beta status from package version

* chore: use user group for code owners

* chore: use github runner for publishing new releases

* chore: fix inconsistencies in github workflows

* fix: dependency chain across all the packages and typos

* fix: reset the crypto-es version

* fix: crypto-js, crypto-es and vulnerable versions

* chore: upgrade size-limit action to the latest version
Copy link
Contributor

coderabbitai bot commented Mar 21, 2024

Walkthrough

The recent updates focus on enhancing workflow efficiency and clarity across GitHub actions, with improvements in naming conventions for better understanding. Changes also include the upgrade of actions and the correction of JavaScript capitalization in various README.md files, reflecting attention to detail and consistency. Additionally, there's an update in test assertions and URL constants to align with current standards, alongside a notable adjustment in code ownership and project versioning to streamline development processes.

Changes

Files Summary
.github/workflows/... Adjustments in naming for steps and Slack notifications, change in runs-on configuration, and restriction on GitHub hosted runners usage.
CODEOWNERS Updated code ownership for a directory to @rudderlabs/js-sdk.
packages/.../README.md Corrected "Javascript" to "JavaScript" across various package descriptions.
packages/analytics-js/__tests__/...
packages/analytics-js/src/constants/urls.ts
Updated test assertion to use a variable and removed beta references in URLs.
sonar-project.properties Updated sonar.projectVersion from 3.0.0-beta.29 to 3.1.0-beta.29.
.github/workflows/security-code-quality-and-bundle-size-checks.yml Updated github-action-check-size-limit action version.

🐇✨

In the world of code, where changes abound,
A rabbit hopped in, making hardly a sound.
"To GitHub actions and READMEs, we go,
Adjusting and tweaking, making it so.
From JavaScript's capital to paths that are new,
Together, we've polished, me and my crew."
🎉🐰

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.

@saikumarrs
Copy link
Member

Invalid PR. Hence, closing it.

@saikumarrs saikumarrs closed this Mar 21, 2024
@saikumarrs saikumarrs deleted the release/3.1.0 branch March 21, 2024 06:58
Copy link

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

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2d804a5 and b6f4ba2.
Files ignored due to path filters (17)
  • migrations.json is excluded by: !**/*.json
  • package-lock.json is excluded by: !**/*.json
  • package.json is excluded by: !**/*.json
  • packages/analytics-js-common/package.json is excluded by: !**/*.json
  • packages/analytics-js-common/project.json is excluded by: !**/*.json
  • packages/analytics-js-integrations/package.json is excluded by: !**/*.json
  • packages/analytics-js-integrations/project.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/package.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/project.json is excluded by: !**/*.json
  • packages/analytics-js-service-worker/package.json is excluded by: !**/*.json
  • packages/analytics-js/package.json is excluded by: !**/*.json
  • packages/analytics-js/project.json is excluded by: !**/*.json
  • packages/analytics-v1.1/package.json is excluded by: !**/*.json
  • packages/loading-scripts/package.json is excluded by: !**/*.json
  • packages/loading-scripts/project.json is excluded by: !**/*.json
  • packages/sanity-suite/package.json is excluded by: !**/*.json
  • packages/sanity-suite/project.json is excluded by: !**/*.json
Files selected for processing (16)
  • .github/workflows/deploy-npm.yml (2 hunks)
  • .github/workflows/deploy-prod.yml (6 hunks)
  • .github/workflows/deploy-staging.yml (1 hunks)
  • .github/workflows/publish-new-release.yml (1 hunks)
  • .github/workflows/security-code-quality-and-bundle-size-checks.yml (1 hunks)
  • CODEOWNERS (1 hunks)
  • packages/analytics-js-common/README.md (1 hunks)
  • packages/analytics-js-integrations/README.md (1 hunks)
  • packages/analytics-js-plugins/README.md (1 hunks)
  • packages/analytics-js-service-worker/README.md (1 hunks)
  • packages/analytics-js/README.md (1 hunks)
  • packages/analytics-js/tests/components/configManager/cdnPaths.test.ts (1 hunks)
  • packages/analytics-js/src/constants/urls.ts (1 hunks)
  • packages/loading-scripts/README.md (1 hunks)
  • packages/sanity-suite/README.md (1 hunks)
  • sonar-project.properties (1 hunks)
Files skipped from review due to trivial changes (1)
  • sonar-project.properties
Additional comments: 22
CODEOWNERS (1)
  • 1-1: The update from individual owners to a team handle (@rudderlabs/js-sdk) for the specified directory is a good practice for managing permissions and responsibilities more efficiently.
packages/analytics-js/src/constants/urls.ts (1)
  • 7-8: Removing beta references in URLs and using production URLs directly is a positive step towards ensuring the stability and reliability of the SDK.
packages/loading-scripts/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the description ensures consistency and accuracy in the documentation.
packages/analytics-js-integrations/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the description ensures consistency and accuracy in the documentation.
packages/sanity-suite/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the description ensures consistency and accuracy in the documentation.
.github/workflows/security-code-quality-and-bundle-size-checks.yml (1)
  • 26-26: Updating the github-action-check-size-limit action to version v2.10.0 is a good practice for incorporating new features or bug fixes.
packages/analytics-js-common/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the description ensures consistency and accuracy in the documentation.
packages/analytics-js-plugins/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the description ensures consistency and accuracy in the documentation.
packages/analytics-js/__tests__/components/configManager/cdnPaths.test.ts (1)
  • 64-64: The modification to use the dummyVersion variable directly in the expected CDN path assertion is a good practice, enhancing test maintainability by avoiding hardcoded values.
packages/analytics-js-service-worker/README.md (1)
  • 24-24: Correcting the capitalization of "Javascript" to "JavaScript" improves the documentation's consistency and professionalism.
packages/analytics-js/README.md (1)
  • 24-24: Correcting the capitalization of "Javascript" to "JavaScript" in the SDK description enhances the documentation's consistency and professionalism.
.github/workflows/publish-new-release.yml (1)
  • 16-16: Changing the runner configuration to ubuntu-latest is a good practice, ensuring the workflow benefits from the latest updates and security patches.
.github/workflows/deploy-staging.yml (3)
  • 72-72: Renaming the step for syncing files to S3 staging directories improves workflow readability and maintainability.
  • 80-80: Updating the Cloudfront invalidation step to remove version-specific references is a good practice, enhancing maintainability.
  • 85-85: Renaming the step for syncing files to S3 v1.1 staging directory for clarity is beneficial.
.github/workflows/deploy-npm.yml (2)
  • 21-21: Restricting the use of GitHub hosted runners for publishing the NPM package with provenance is a good security practice.
  • 75-75: Adjusting the Slack message naming for clarity in notifications is beneficial.
.github/workflows/deploy-prod.yml (5)
  • 98-98: The step name "Sync files to S3" has been simplified from "Sync files to S3 v3 folder" to enhance clarity. This change aligns with the PR's objective of refining deployment processes.
  • 110-110: Renaming "Sync files to S3 v3 versioned folder" to "Sync files to S3 versioned directory" improves consistency in terminology by using "directory" instead of "folder." Good attention to detail.
  • 137-137: The step "Send message to Slack channel" has been renamed for simplicity. This change, along with the updated payload structure, should improve the clarity of Slack notifications regarding new releases.
  • 172-172: Renaming "Sync files to S3 v1.1 folder" to "Sync files to S3 v1.1 directory" is consistent with the changes made earlier in the file. It's good to see uniformity in naming conventions across the workflow.
  • 187-187: The renaming of "Sync files to S3 v1.1 versioned folder" to "Sync files to S3 v1.1 versioned directory" maintains consistency in the use of the term "directory." This change is in line with best practices for clear and consistent naming.

@@ -119,7 +119,7 @@ jobs:
run: |
AWS_MAX_ATTEMPTS=10 aws cloudfront create-invalidation --distribution-id ${{ secrets.AWS_PROD_CF_DISTRIBUTION_ID }} --paths "/${{ env.CURRENT_VERSION_VALUE }}/*"

# TODO: The '/latest' folder is unused. Might be removed in future.
# TODO: The '/latest' directory is unused. Might be removed in future.
Copy link
Contributor

Choose a reason for hiding this comment

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

The comment regarding the unused '/latest' directory is helpful for future maintenance. It might be beneficial to track this as a technical debt item or create a follow-up task to evaluate and potentially remove the unused directory.

Would you like me to open a GitHub issue to track the evaluation and potential removal of the '/latest' directory?

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.03% ▼) 8 KB
Core CJS - NPM 22.43 KB 22.45 KB (+0.1% ▲) 23 KB
Core - NPM 22.6 KB 22.53 KB (-0.33% ▼) 23 KB
Core Legacy - CDN 42.88 KB 42.86 KB (-0.04% ▼) 44 KB
Core - CDN 22.7 KB 22.69 KB (-0.03% ▼) 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.

4 participants