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

chore: add npm script to report deprecated but unremoved api #11366

Closed
wants to merge 2 commits into from

Conversation

sgtcoolguy
Copy link
Contributor

@sgtcoolguy sgtcoolguy commented Nov 25, 2019

Optional Description:
This adds an npm script: npm run deprecations which will parse the apidocs and find types/properties/methods we've marked as deprecated but have not yet marked as removed.

Lists the APIs in order from oldest deprecated version to newest. This should give a good listing for things we need to get rid of in breaking change releases.

Gives me:
Screen Shot 2019-11-25 at 4 11 10 PM

@sgtcoolguy sgtcoolguy requested review from a team November 25, 2019 21:08
@sgtcoolguy
Copy link
Contributor Author

Relates to #11362

Note that I didn't have it check method parameters or events.

@sgtcoolguy
Copy link
Contributor Author

sgtcoolguy commented Nov 25, 2019

cc @janvennemann this probably should go into appcelerator/docs-devkit with a parameter to filter out results with a new-enough version (i.e. when we lint modules or sdk api docs, we can pass in an argument and say, show me all results so long as the deprecated since version is < 8.0.0)

@sgtcoolguy
Copy link
Contributor Author

Also possibly useful? another variant that finds deprecated and removed APIs older than version X for potential removal from the apidocs altogether (i.e. we probably don't need to document APIs that have been removed 2/3+ years ago any more)

@sgtcoolguy
Copy link
Contributor Author

OK, followed it up with another script that can show the "old" removed apis to give us a listing of things we should consider dropping from the YML docs altogether. For now it's set to consider any API removed prior to 7.0.0 release.

@build build added this to the 9.0.0 milestone Nov 25, 2019
@build
Copy link
Contributor

build commented Nov 25, 2019

Warnings
⚠️ There is no linked JIRA ticket in the PR body. Please include the URL of the relevant JIRA ticket. If you need to, you may file a ticket on JIRA
Messages
📖

💾 Here's the generated SDK zipfile.

📖 ✊ The commits in this PR match our conventions! Feel free to Rebase and Merge this PR when ready.
📖

✅ All tests are passing
Nice one! All 6552 tests are passing.
(There are 711 skipped tests not included in that total)

Generated by 🚫 dangerJS against b31bfed

Copy link
Contributor

@janvennemann janvennemann left a comment

Choose a reason for hiding this comment

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

Awesome! This will be really helpful in cleaning up our code base and docs. Code looks good, approved!

@sgtcoolguy
Copy link
Contributor Author

merged manually

@sgtcoolguy sgtcoolguy closed this Nov 26, 2019
@sgtcoolguy sgtcoolguy deleted the deprecations branch November 26, 2019 13:49
@sgtcoolguy sgtcoolguy mentioned this pull request Nov 26, 2019
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.

None yet

3 participants