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 minimum Android API level and add workflow to check compatibility #2431

Merged

Conversation

Marcono1234
Copy link
Collaborator

@Marcono1234 Marcono1234 commented Jul 6, 2023

Purpose

Resolves #2429

Description

This is based on the discussion in #2429

  • Documents minimum Android API level of 21 for the next Gson version (2.11.0 probably)
    For older versions it claims the minimum API level is 19 because Animal Sniffer did not find any violations there for the latest code from main. If it turns out that previous versions were actually incompatible with API level 19 we will have to adjust the README.
  • Executes Animal Sniffer (as separate GitHub workflow) to verify compatibility

Checklist

  • New code follows the Google Java Style Guide
  • If necessary, new public API validates arguments, for example rejects null
  • New public API has Javadoc
    • Javadoc uses @since $next-version$
      ($next-version$ is a special placeholder which is automatically replaced during release)
  • If necessary, new unit tests have been added
    • Assertions in unit tests use Truth, see existing tests
    • No JUnit 3 features are used (such as extending class TestCase)
    • If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
  • mvn clean verify javadoc:jar passes without errors

Copy link
Member

@eamonnmcmanus eamonnmcmanus left a comment

Choose a reason for hiding this comment

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

Thanks, this looks great!

@eamonnmcmanus eamonnmcmanus merged commit 6d9c356 into google:main Jul 6, 2023
@Marcono1234 Marcono1234 deleted the marcono1234/check-android-api branch July 6, 2023 19:57
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.

Specify minimum Android API level (+ add Animal Sniffer to verify this)
2 participants