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 #1656

Closed
wants to merge 12 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

  • New Features
    • Introduced a new version 0.0.1 across multiple packages with dependency updates and a link to the comparison between versions for analytics-js-common.
  • Documentation
    • Updated the capitalization of "Javascript" to "JavaScript" across various README.md files for consistency and clarity.
    • Updated changelogs and latest version documentation in multiple packages.
  • Refactor
    • Updated GitHub Actions workflows to use GitHub hosted runners and simplified task names for clarity.
    • Updated URLs in the code from beta versions to production versions.
  • Chores
    • Updated the CODEOWNERS file with new ownership information.
    • Updated the sonar.projectVersion to reflect the new beta version.
  • Tests
    • Simplified the test expectation for the CDN path in cdnPaths.test.ts.

saikumarrs and others added 12 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 changes largely focus on standardizing terminology, updating dependencies, and refining automation workflows. Key updates include the shift from beta to production versions in URLs and dependencies, the correction of "Javascript" to "JavaScript" across documentation, and the streamlining of GitHub Actions workflows. These modifications enhance consistency, improve deployment processes, and ensure the use of the latest software components.

Changes

File Path Change Summary
.github/workflows/... Updated runs-on directives, renamed steps for clarity, and standardized task names.
CODEOWNERS Updated ownership information to @rudderlabs/js-sdk.
packages/.../CHANGELOG.md, packages/.../CHANGELOG_LATEST.md Introduced new versions and updated dependencies.
packages/.../README.md Corrected "Javascript" to "JavaScript".
packages/analytics-js/__tests__/.../cdnPaths.test.ts, packages/analytics-js/src/constants/urls.ts Simplified test expectations and updated URLs to production versions.
sonar-project.properties Updated sonar.projectVersion to 3.1.0-beta.29.

🐰✨
A rabbit hopped through fields of code,
Where JavaScript now rightly flowed.
From beta paths to production roads,
With every leap, the future glowed.
🌟 Changes made, with care and might,
Ensuring every byte was right.
🎉 Celebrate, for we've seen the light!
🐰✨

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.

Copy link

codecov bot commented Mar 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.89%. Comparing base (2d804a5) to head (a9d2079).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1656   +/-   ##
=======================================
  Coverage   53.89%   53.89%           
=======================================
  Files         461      461           
  Lines       15588    15588           
  Branches     3097     3087   -10     
=======================================
  Hits         8401     8401           
- Misses       5881     5919   +38     
+ Partials     1306     1268   -38     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2d804a5 and a9d2079.
Files ignored due to path filters (18)
  • 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/analytics-v1.1/project.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 (29)
  • .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/CHANGELOG.md (1 hunks)
  • packages/analytics-js-common/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-common/README.md (1 hunks)
  • packages/analytics-js-integrations/CHANGELOG.md (1 hunks)
  • packages/analytics-js-integrations/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-integrations/README.md (1 hunks)
  • packages/analytics-js-plugins/CHANGELOG.md (1 hunks)
  • packages/analytics-js-plugins/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-plugins/README.md (1 hunks)
  • packages/analytics-js-service-worker/README.md (1 hunks)
  • packages/analytics-js/CHANGELOG.md (1 hunks)
  • packages/analytics-js/CHANGELOG_LATEST.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/analytics-v1.1/CHANGELOG.md (1 hunks)
  • packages/analytics-v1.1/CHANGELOG_LATEST.md (1 hunks)
  • packages/loading-scripts/CHANGELOG.md (1 hunks)
  • packages/loading-scripts/CHANGELOG_LATEST.md (1 hunks)
  • packages/loading-scripts/README.md (1 hunks)
  • packages/sanity-suite/CHANGELOG.md (1 hunks)
  • packages/sanity-suite/README.md (1 hunks)
  • sonar-project.properties (1 hunks)
Files skipped from review due to trivial changes (13)
  • packages/analytics-js-integrations/CHANGELOG.md
  • packages/analytics-js-integrations/README.md
  • packages/analytics-js-plugins/CHANGELOG.md
  • packages/analytics-js-plugins/CHANGELOG_LATEST.md
  • packages/analytics-js-plugins/README.md
  • packages/analytics-js-service-worker/README.md
  • packages/analytics-js/CHANGELOG_LATEST.md
  • packages/analytics-v1.1/CHANGELOG.md
  • packages/analytics-v1.1/CHANGELOG_LATEST.md
  • packages/loading-scripts/CHANGELOG.md
  • packages/sanity-suite/CHANGELOG.md
  • packages/sanity-suite/README.md
  • sonar-project.properties
Additional comments: 22
CODEOWNERS (1)
  • 1-1: The transition to a team-based approach for code ownership (@rudderlabs/js-sdk) is a positive change, promoting scalability and maintainability of the project. This approach ensures shared responsibility and potentially improves response times for PR reviews and issue resolutions.
packages/analytics-js-common/CHANGELOG_LATEST.md (1)
  • 1-1: The version update from 3.0.0-beta.19 to 0.0.1 is significant, indicating a major overhaul or rebranding. It's crucial to ensure clear communication to users about the nature and implications of these changes, as resetting the version number after a beta release could potentially cause confusion.
packages/analytics-js-integrations/CHANGELOG_LATEST.md (1)
  • 1-5: Updating the version to 0.0.1 and the dependency @rudderstack/analytics-js-common to version 0.0.1 are significant changes. It's important to ensure thorough testing of these updates to maintain compatibility and stability across the ecosystem.
packages/loading-scripts/CHANGELOG_LATEST.md (1)
  • 1-5: The version change to 0.0.1 and the update to @rudderstack/analytics-js version 0.0.1 are significant. Clear communication about these changes and thorough testing of the updates are essential to ensure a smooth transition for users.
packages/analytics-js/src/constants/urls.ts (1)
  • 7-8: Updating URLs from beta to production versions is a positive step towards stabilizing the project. Ensure the correctness of these URLs and verify that any necessary redirects are in place to avoid breaking existing implementations.
.github/workflows/security-code-quality-and-bundle-size-checks.yml (1)
  • 26-26: Updating the github-action-check-size-limit to v2.10.0 is a good practice to benefit from new features or bug fixes. Ensure compatibility with the existing workflow and verify that no breaking changes are introduced.
packages/analytics-js-common/README.md (1)
  • 24-24: Correcting the capitalization of "JavaScript" in the documentation is a minor but important detail that enhances professionalism and accuracy. Good attention to detail.
packages/analytics-js/__tests__/components/configManager/cdnPaths.test.ts (1)
  • 64-64: The test case for verifying the default path with versioned folder when no script src exists and integrations version is locked correctly uses the dummyVersion variable. This approach ensures that the test remains valid even if the version changes, avoiding the need to update the hardcoded version in the test. This change aligns with best practices for maintainability and flexibility in test cases.
.github/workflows/publish-new-release.yml (1)
  • 16-16: Changing the runs-on configuration to ubuntu-latest for the release job is a positive move towards standardization and reliability. Using GitHub-hosted runners can provide a more consistent environment for deployments and reduce the maintenance overhead associated with self-hosted runners. Ensure that any dependencies or environment specifics tied to the self-hosted runner are compatible with ubuntu-latest.
.github/workflows/deploy-staging.yml (3)
  • 72-72: Renaming the task to "Sync files to S3 staging directory" improves clarity and accurately describes the action being performed. This change enhances the readability of the workflow file and makes it easier for new contributors to understand the purpose of each step.
  • 80-80: Updating the task name to "Create Cloudfront invalidation" clearly communicates the action being taken. This naming convention is straightforward and aligns with best practices for naming tasks in a way that immediately conveys their purpose.
  • 85-85: The task name "Sync files to S3 v1.1 staging directory" is well-chosen, providing clear insight into the specific action and target directory. This level of detail in task naming facilitates easier maintenance and understanding of the workflow.
.github/workflows/deploy-npm.yml (2)
  • 21-21: Switching to ubuntu-latest for the runs-on directive aligns with best practices for using GitHub hosted runners, especially for critical operations like publishing to NPM. This ensures a stable and consistent environment for the deployment process. It's important to verify that all dependencies and scripts are compatible with the ubuntu-latest environment.
  • 75-75: Modifying the step name to "Send message to Slack channel" provides a clear and concise description of the action being performed. This change enhances the readability of the workflow and makes it easier for contributors to navigate and understand the purpose of each step.
packages/analytics-js-common/CHANGELOG.md (1)
  • 5-5: The introduction of version 0.0.1 marks a significant change from the previous beta versioning scheme. Please ensure that the version jump from 3.0.0-beta.19 to 0.0.1 is clearly communicated in the release notes or documentation to avoid confusion among users.
.github/workflows/deploy-prod.yml (6)
  • 98-98: Renaming the step from "Sync files to S3 v3 folder" to "Sync files to S3" improves clarity by removing the version number, which might not be necessary for understanding the step's purpose. This change aligns with best practices for naming by keeping it simple and focused on the action being performed.
  • 110-110: The renaming of "Sync files to S3 v3 versioned folder" to "Sync files to S3 versioned directory" not only corrects the terminology (from "folder" to "directory") but also removes the specific version number, making the step name more generic and potentially applicable to future versions without needing further changes.
  • 122-122: Updating the comment to mention the '/latest' directory instead of '/latest' folder is a minor but meaningful change that aligns with the more commonly used terminology in the context of directories and paths in development and deployment scripts. It's good to see attention to detail in comments as well, as they guide future maintainers.
  • 137-137: Renaming the step "Send message to Slack channel v3" to "Send message to Slack channel" simplifies the step name by removing the version number. This change is consistent with the approach taken in other step renamings and helps in maintaining a cleaner and more understandable workflow file.
  • 172-172: The renaming of "Sync files to S3 v1.1 folder" to "Sync files to S3 v1.1 directory" corrects the terminology and makes the step name more precise. It's important to use consistent terminology across the workflow file, and this change contributes to that consistency.
  • 187-187: Renaming "Sync files to S3 v1.1 versioned folder" to "Sync files to S3 v1.1 versioned directory" is another instance of improving terminology consistency within the workflow file. This change, along with the others, helps in making the workflow steps clearer and more standardized.
packages/analytics-js/CHANGELOG.md (1)
  • 5-10: The changelog update correctly documents the dependency updates for @rudderstack/analytics-js-common and @rudderstack/analytics-js-plugins to version 0.0.1. Ensure that the version numbers are accurate and that the provided links lead to the correct comparison pages on GitHub.

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.44 KB (+0.02% ▲) 23 KB
Core - NPM 22.6 KB 22.56 KB (-0.2% ▼) 23 KB
Core Legacy - CDN 42.88 KB 42.89 KB (+0.04% ▲) 44 KB
Core - CDN 22.7 KB 22.68 KB (-0.07% ▼) 23 KB
Core (legacy build) - CDN - v1.1 31.54 KB 31.45 KB (-0.27% ▼) 32 KB
Core - NPM - v1.1 31.52 KB 31.5 KB (-0.09% ▼) 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

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