Ticket #1888 (closed todo: done)

Opened 3 years ago

Last modified 3 years ago

Deprecations as data

Reported by: dukeleto Owned by: dukeleto
Priority: major Milestone: 2.11
Component: hll_interop Version: 2.10.0
Severity: medium Keywords:
Cc: Language:
Patch status: Platform: all

Description

All of our deprecations should be stored in a file in the Parrot git repo. The format of the file isn't important, whichever is the simplest is probably best. YAML or JSON or CSV are probably the top contenders for a format.

This file is very important because then we can build tools that use this deprecation data to generate code, or helpful instructions to HLL devs when they are "paying an upgrade tax". For example:

A script that looks at the source code of an HLL and then spits out which deprecated features are being used and the dates/versions when they are eligble to be removed and a wiki page link for how to use whatever is replacing the deprecation.

Change History

Changed 3 years ago by dukeleto

  • status changed from new to assigned
  • owner set to dukeleto
  • component changed from none to hll_interop
  • priority changed from normal to major

We need a spec for what information we want to store about a deprecation and a script that will transform DEPRECATED.pod into DEPRECATED.yaml

Changed 3 years ago by tadzik

I made it DEPRECATED.json, lives in a branch  https://github.com/parrot/parrot/commits/tadzik/deprecated-json

Changed 3 years ago by tadzik

It's now YAML, pushed to master, and @parrot-dev is notified. May need some docs (DEPRECATED.README?) so editors of the file will know how is it formatted and why.

Changed 3 years ago by dukeleto

  • status changed from assigned to closed
  • resolution set to done

This file is now called api.yaml and there are two tools to interact with it: tools/dev/show_deprecations.pl shows current deprecations and tools/dev/show_experimental.pl shows current experimental features.

Note: See TracTickets for help on using tickets.