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 Dependabot versioning strategy #1543

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

Imod7
Copy link
Contributor

@Imod7 Imod7 commented Nov 11, 2024

Current Setup

After reviewing this Dependabot PR #1534, I noticed that Dependabot does not update the package.json file. This is the expected behaviour since polkadot deps are using the caret ^ in package.json and Dependabot does not need to update it (default Dependabot versioning is auto).

Example

  • package.json has a dependency in some version "example-dep": "^14.1.1"
  • Dependabot will bump the version to the latest one (either patch or minor), e.g. 14.x.x version so 14.2.2 or 14.1.3
  • It will not update the package.json since it is a compatible version with the range that it is shown in package.json.

Proposed Change

Explicitly set Dependabot's versioning-strategy to increase which will update also the version in package.json even if it is in the compatible range.

Example

  • Same updates as above with the only difference that the Dependabot will now also update the package.json even if it is a compatible version / within the range specified in package.json.

Reason for this Change

In Sidecar, it is quite important to know the exact versions of polkadot-js dependencies we are using. In the case of issues, the first thing that we do when debugging is to check in package.json which version of polkadot deps we are using and then research the changes in the corresponding repos. Even minor or patch releases of polkadot-js packages can affect Sidecar. Therefore, I think its important that package.json reflects the exact pjs dep versions, so we do not have to check the yarn.lock every time to verify this.

Alternative Solution

I think we would have the same result if we remove the carets from the polkadot js deps. Example from asset-transfer-api :

@Imod7 Imod7 requested review from a team as code owners November 11, 2024 14:35
Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

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

Nice catch

@Imod7 Imod7 merged commit 158a1f8 into master Nov 11, 2024
13 of 14 checks passed
@Imod7 Imod7 deleted the domi-dependabot-versioning branch November 11, 2024 15:06
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.

3 participants