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

Document automatic dependency downgrade option #874

Merged
merged 2 commits into from
Feb 17, 2025

Conversation

ezgidemirel
Copy link
Member

This PR documents how people can enable automatic dependency version upgrade and downgrade functionalities.

@ezgidemirel ezgidemirel requested a review from jbw976 February 7, 2025 13:51
Copy link

netlify bot commented Feb 7, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit e98a6d9
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/67b05e18e471b80008089c25
😎 Deploy Preview https://deploy-preview-874--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86 (🟢 up 2 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@ezgidemirel ezgidemirel force-pushed the pkg-downgrade branch 2 times, most recently from 55dd688 to 4d0165a Compare February 11, 2025 08:45
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

Thanks for following up with this documentation @ezgidemirel, sorry we didn't get it into the release yesterday. Can you please rebase this commit on the latest (post release) and then also copy the content to the v1.19 folder to "backport" it?


Crossplane can automatically upgrade a package's dependency version to the minimum
valid version that satisfies all the constraints. It's an alpha feature that
requires enabling with the `--enable-dependency-version-upgrades` flag.
Copy link
Member

Choose a reason for hiding this comment

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

should we link here to help on how to set feature flags?

Copy link
Member Author

@ezgidemirel ezgidemirel Feb 13, 2025

Choose a reason for hiding this comment

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

added in the following note section

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

looks mostly good to me @ezgidemirel, just one small nit about linking directly to the feature flags table, but otherwise this is a helpful addition to the docs! thank you! 🙇‍♂️

Please check the
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
and
[feature flags]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
Copy link
Member

Choose a reason for hiding this comment

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

i think this link could be ../software/install/#feature-flags instead, which goes right to the feature flags

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks for the catch @jbw976! I copy/pasted it from the pods file didn't notice the wrong reference. I also fixed it in the pods.md files

Please check the
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
and
[feature flags]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
Copy link
Member

Choose a reason for hiding this comment

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

same here, this link could probably be ../software/install/#feature-flags

valid version that satisfies all the constraints. It's an alpha feature that
requires enabling with the `--enable-dependency-version-upgrades` flag.

In some cases, dependency version downgrade is required for proceeding with
Copy link
Member

Choose a reason for hiding this comment

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

this is a super helpful description, thank you for adding this! well done 🙇‍♂️

@jbw976
Copy link
Member

jbw976 commented Feb 14, 2025

no new vale errors introduced by this PR, so vale looks OK to me ✅

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
@jbw976 jbw976 merged commit 992b618 into crossplane:master Feb 17, 2025
6 of 7 checks passed
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.

2 participants