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

Remove .package-version file and its usage #6840

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pazone
Copy link
Contributor

@pazone pazone commented Feb 12, 2025

What does this PR do?

Removes the .package-version file and all usages.

Why is it important?

The .package-version file is not required anymore and brings unnecessary complexity to the CI and related codebase

Checklist

  • I have read and understood the pull request guidelines of this project.
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in ./changelog/fragments using the changelog tool
  • I have added an integration test or an E2E test

Disruptive User Impact

How to test this PR locally

Related issues

Questions to ask yourself

  • How are we going to support this in production?
  • How are we going to measure its adoption?
  • How are we going to debug this?
  • What are the metrics I should take care of?
  • ...

@pazone pazone added enhancement New feature or request skip-changelog backport-active-all Automated backport with mergify to all the active branches labels Feb 12, 2025
@mergify mergify bot assigned pazone Feb 12, 2025
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

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

See analysis details on SonarQube

# There is a time when the current snapshot is not available on cloud yet, so we cannot use the latest version automatically
# This file is managed by an automation (mage integration:UpdateAgentPackageVersion) that check if the snapshot is ready.

STACK_VERSION="$(cat .package-version)"
Copy link
Member

Choose a reason for hiding this comment

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

OK reading everything this does, we actually want to keep this as a way to have a lagging update of the stack version. Since we will bump the agent version from N to N+1 but need to test against stack version N until the first snapshot for N+1 is produced.

Let's keep that part of this.

We should not need to change the actual agent version anymore, the fact that we do this without consequence is a hint we can just relax the version constraints for convenience where necessary. We already did this for minors, but didn't handle majors properly yet.

Copy link
Member

Choose a reason for hiding this comment

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

I would rename the file to .stack-version (and the associated mage target) and remove anything that sets the agent package version (which is the version agent reports itself as to the stack).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then the .stack-version should also be auto-updated, right?

Copy link
Member

Choose a reason for hiding this comment

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

Yes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do I understand it correctly that this PR doesn't make much sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-active-all Automated backport with mergify to all the active branches enhancement New feature or request skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants