-
Notifications
You must be signed in to change notification settings - Fork 45
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
feat: return deprecation warnings to users in yellow in colour. #586
Conversation
feat: added abstractions for deprecation warning
92348f5
to
2e2e8b2
Compare
To add deprecation warning we can just do the following: Deprecating an argument/field for instruction or type:-
The warning message will be: Deprecating an instruction or type:-
The warning message will be: |
...tainer/server/startosis_engine/kurtosis_starlark_framework/kurtosis_base_builtin_internal.go
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Peeeekay This looks good to me. My understanding is that this is the first PR. I see you have some todo's, are those meant for future work, or are those coming up in the next PR?
Either way this looks like a good first prototype.
@adschwartz - those are future work which can be tackled as FLUPs - which I will create. They are not urgent but good to have. |
🤖 I have created a release *beep* *boop* --- ## [0.76.4](0.76.3...0.76.4) (2023-05-11) ### Features * Add Windows support for CLI ([#608](#608)) ([4cc1c56](4cc1c56)) * added sign-up for kcloud ([#591](#591)) ([16641e9](16641e9)) * Help developers to work across the project modules ([#596](#596)) ([e7f845e](e7f845e)) * return deprecation warnings to users in yellow in colour. ([#586](#586)) ([7609fd8](7609fd8)) ### Bug Fixes * Enable autocomplete for the `files upload` path argument ([#598](#598)) ([be52f9e](be52f9e)) * kurtosis --> kurtosistech in readme ([#604](#604)) ([d6c2ea2](d6c2ea2)) * Pipe metric reporting logs to logger instead of stderr ([#576](#576)) ([7060473](7060473)) * Refresh the README dev instructions ([#595](#595)) ([0c71fac](0c71fac)) * rename cloud-->kloud in readme ([#602](#602)) ([a998d39](a998d39)) * Support redirects with cookies in the user support URLs validation test ([#600](#600)) ([ce9718e](ce9718e)), closes [#599](#599) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot <kurtosisbot@users.noreply.github.com>
Description:
After this change - users can be notified about potential deprecated instructions/types/fields. It is abstracted away so that engineers can easily add relevant information for users to see. They also have ability to share other warning with users if need be.
Is this change user facing?
YES
References (if applicable):