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: fix changelog generation #1817

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Aug 1, 2024

PR Description

Fixed the version target options of all the packages to push updates at the end to help in generating correct changelogs.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2227/fix-changelog-generation-during-release

Cross Browser Tests

N/A

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

  • New Features
    • Introduced a new parameter to specify use of the pull request's head SHA in the deployment workflow for increased flexibility.
  • Improvements
    • Enhanced the checkout process across multiple workflows to ensure the exact commit associated with a pull request or build is used, improving reliability and consistency in deployments.
    • Added references to pull request head SHA in relevant workflows to ensure the most up-to-date code is tested and deployed.

@saikumarrs saikumarrs self-assigned this Aug 1, 2024
Copy link
Contributor

coderabbitai bot commented Aug 1, 2024

Walkthrough

Walkthrough

The recent changes to the GitHub Actions workflows primarily focus on enhancing the checkout process by ensuring that the exact commit or pull request head SHA is used during deployments and testing. This modification increases the reliability and traceability of workflows by aligning the code being built or tested with the specific commit that triggered the action. Additionally, a new input parameter introduces flexibility for utilizing the pull request's latest changes, further improving deployment accuracy.

Changes

File Change Summary
.github/workflows/deploy-npm.yml Added ref: ${{ github.sha }} to the checkout action for precise commit checkout.
.github/workflows/deploy-sanity-suite.yml Added with: ref: ${{ github.sha }} to the Checkout step for exact commit handling.
.github/workflows/deploy.yml Introduced use_pr_head_sha parameter to optionally use pull request head SHA; modified checkout step accordingly.
.github/workflows/publish-new-release.yml Added ref: ${{ github.sha }} to ensure checkout of the specific commit.
.github/workflows/security-code-quality-and-bundle-size-checks.yml Enhanced checkout to use ref: ${{ github.event.pull_request.head.sha }} for pull request accuracy.
.github/workflows/unit-tests-and-lint.yml Specified ref: ${{ github.event.pull_request.head.sha }} in checkout to ensure correct commit for testing.

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 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 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 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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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

sonarqubecloud bot commented Aug 1, 2024

@saikumarrs saikumarrs marked this pull request as ready for review August 1, 2024 15:53
@saikumarrs saikumarrs requested a review from a team August 1, 2024 15:53
@saikumarrs saikumarrs requested a review from a team as a code owner August 1, 2024 15:53
@saikumarrs saikumarrs merged commit 815b9bf into develop Aug 1, 2024
9 checks passed
@saikumarrs saikumarrs deleted the chore.fix-changelog-generation-sdk-2227 branch August 1, 2024 15:53
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6f120aa and d405d65.

Files ignored due to path filters (9)
  • packages/analytics-js-common/project.json is excluded by !**/*.json
  • packages/analytics-js-cookies/project.json is excluded by !**/*.json
  • packages/analytics-js-integrations/project.json is excluded by !**/*.json
  • packages/analytics-js-plugins/project.json is excluded by !**/*.json
  • packages/analytics-js-service-worker/project.json is excluded by !**/*.json
  • packages/analytics-js/project.json is excluded by !**/*.json
  • packages/analytics-v1.1/project.json is excluded by !**/*.json
  • packages/loading-scripts/project.json is excluded by !**/*.json
  • packages/sanity-suite/project.json is excluded by !**/*.json
Files selected for processing (6)
  • .github/workflows/deploy-npm.yml (1 hunks)
  • .github/workflows/deploy-sanity-suite.yml (1 hunks)
  • .github/workflows/deploy.yml (2 hunks)
  • .github/workflows/publish-new-release.yml (1 hunks)
  • .github/workflows/security-code-quality-and-bundle-size-checks.yml (2 hunks)
  • .github/workflows/unit-tests-and-lint.yml (1 hunks)
Additional comments not posted (9)
.github/workflows/unit-tests-and-lint.yml (1)

24-24: LGTM! The ref parameter enhances the checkout step.

The addition of the ref parameter ensures that the workflow checks out the specific commit associated with the pull request, improving reliability and traceability.

.github/workflows/security-code-quality-and-bundle-size-checks.yml (2)

18-19: LGTM! The ref parameter enhances the checkout step.

The addition of the ref parameter ensures that the workflow checks out the specific commit associated with the pull request, improving reliability and traceability.


48-48: LGTM! The ref parameter enhances the checkout step.

The addition of the ref parameter ensures that the workflow checks out the specific commit associated with the pull request, improving reliability and traceability.

.github/workflows/publish-new-release.yml (1)

43-43: LGTM! The ref parameter enhances the checkout step.

The addition of the ref parameter ensures that the workflow checks out the specific commit associated with the pull request, improving reliability and traceability.

.github/workflows/deploy-sanity-suite.yml (1)

62-63: LGTM! Ensuring the exact commit SHA is checked out.

The addition of the with clause specifying ref: ${{ github.sha }} ensures that the workflow checks out the exact commit that triggered the workflow. This enhances the consistency and reliability of the deployment process.

.github/workflows/deploy-npm.yml (1)

39-39: LGTM! Ensuring the exact commit SHA is checked out.

The addition of the ref parameter specifying ref: ${{ github.sha }} ensures that the workflow checks out the exact commit that triggered the workflow. This enhances the reliability of the build process by ensuring that the code being built corresponds precisely to the commit in question.

.github/workflows/deploy.yml (3)

27-29: LGTM! Introducing the use_pr_head_sha input parameter.

The new input parameter use_pr_head_sha allows users to specify whether to use the SHA of the pull request's head instead of the default commit SHA. This enhances the flexibility of the workflow.


69-79: LGTM! Determining the checkout SHA based on the new input parameter.

The new step determines which SHA to use based on the value of use_pr_head_sha. If the input is 'true', the SHA from the pull request's head is used; otherwise, the default commit SHA is retained. This step ensures that the correct SHA is used for the checkout process.


82-83: LGTM! Using the determined SHA for the checkout step.

The checkout step now references the determined SHA. This ensures that the workflow checks out the correct commit based on the logic defined in the previous step.

Copy link

github-actions bot commented Aug 1, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.53 KB 1.53 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.88 KB 15.88 KB (0%) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.19 KB 7.19 KB (0%) 7.5 KB
Common - No bundling 15.89 KB 15.89 KB (0%) 16.5 KB
Service Worker - Legacy - NPM (ESM) 29.46 KB 29.46 KB (0%) 30 KB
Service Worker - Legacy - NPM (CJS) 29.61 KB 29.61 KB (0%) 30 KB
Service Worker - Legacy - NPM (UMD) 29.44 KB 29.44 KB (0%) 30 KB
Service Worker - Modern - NPM (ESM) 24.59 KB 24.59 KB (0%) 25 KB
Service Worker - Modern - NPM (CJS) 24.88 KB 24.88 KB (0%) 25 KB
Service Worker - Modern - NPM (UMD) 24.67 KB 24.67 KB (0%) 25 KB
Core (v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 29.89 KB 29.89 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.33 KB 29.33 KB (0%) 30 KB
Core (Content Script - v1.1) - NPM (CJS) 29.54 KB 29.54 KB (0%) 30 KB
Core (Content Script - v1.1) - NPM (UMD) 29.42 KB 29.42 KB (0%) 30 KB
Core - Legacy - CDN 47.4 KB 47.4 KB (0%) 48 KB
Core - Modern - CDN 24.09 KB 24.09 KB (0%) 24.5 KB
Load Snippet 724 B 724 B (0%) 1 KB
Core - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB
Core - Legacy - NPM (CJS) 47.5 KB 47.5 KB (0%) 48 KB
Core - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB
Core - Modern - NPM (ESM) 23.83 KB 23.83 KB (0%) 24.5 KB
Core - Modern - NPM (CJS) 24.06 KB 24.06 KB (0%) 24.5 KB
Core - Modern - NPM (UMD) 23.86 KB 23.86 KB (0%) 24.5 KB
Core (Bundled) - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB
Core (Bundled) - Legacy - NPM (CJS) 47.53 KB 47.53 KB (0%) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB
Core (Bundled) - Modern - NPM (ESM) 38.54 KB 38.54 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (CJS) 38.8 KB 38.8 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (UMD) 38.53 KB 38.53 KB (0%) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 46.75 KB 46.75 KB (0%) 47 KB
Core (Content Script) - Legacy - NPM (CJS) 47.01 KB 47.01 KB (0%) 47.5 KB
Core (Content Script) - Legacy - NPM (UMD) 46.77 KB 46.77 KB (0%) 47 KB
Core (Content Script) - Modern - NPM (ESM) 38.01 KB 38.01 KB (0%) 38.5 KB
Core (Content Script) - Modern - NPM (CJS) 38.3 KB 38.3 KB (0%) 38.5 KB
Core (Content Script) - Modern - NPM (UMD) 37.99 KB 37.99 KB (0%) 38.5 KB
All Integrations - Legacy - CDN 93.92 KB 93.92 KB (0%) 95.3 KB
All Integrations - Modern - CDN 88.8 KB 88.8 KB (0%) 91 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.

1 participant