RFC - Implement a structured process for deprecating javascript/Vue code
This is a request for comments (RFC) to implement a structured process for deprecating javascript/Vue code in the GitLab Monorepo
The subject of code deprecation has come up a few times in the Frontend Department Meeting and this issue attempts to find a good solution to handle those use-cases.
Related conversations:
- gitlab-org/gitlab-ui!1703 (comment 425527590)
- gitlab-org/gitlab!45373 (comment 432105079)
- https://gitlab.slack.com/archives/C9Q5V0597/p1603121667107700?thread_ts=1603121613.107600&cid=C9Q5V0597
A few requirements I can think of:
- The developers should be alerted when they use code that is deprecated, preferably at development time
- There should be a mechanism to direct developers to what to do instead, perhaps through a link to an issue explaining why the current path is not viable
- Should work for both javascript and Vue components
This does not try to solve:
- Deprecation of files (We have a mechanism for deprecating style files using this Dangerfile)
- Deprecation of Ruby code
- Deprecation of styles
Reference implementation
Please see the proposed solution here: gitlab-org/gitlab!51991 (merged)
Edited by Ragnar Hardarson