Skip to content

Update release docs #653

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.

Sign up for GitHub

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

Merged
mit-mit merged 2 commits into from
Aug 17, 2017
Merged

Update release docs #653

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf9d377
Update release docs
mit-mit Aug 16, 2017
68c8e35
Review feedback
mit-mit Aug 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 27 additions & 12 deletions android-release-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,36 @@ When you're ready to prepare a *release* version for Android, for example to
* TOC Placeholder
{:toc}

## Reviewing the App Manifest
## Review the App Manifest

When you create a new app, a default [App Manifest][manifest] file `AndroidManifest.xml`
is created in `<app dir>/android/app/src/main/`. Before releasing,
review the contents of this file and verify the values are correct, especially:
Review the default [App Manifest][manifest] file `AndroidManifest.xml` located
in `<app dir>/android/app/src/main/` and verify the values are correct,
especially:

* `application`: Edit the [`application`][applicationtag] tag to reflect the final name of the app.
* `application`: Edit the [`application`][applicationtag] tag to reflect the
final name of the app.

* `manifest`: Specify the [version][versions] code and name in the [`manifest`][manifesttag] tag.
* `uses-permission`: Remove the `android.permission.INTERNET`
[permission][permissiontag] if your application code does not need Internet
access. The standard template includes this tag to enable communication between
Flutter tools and a running app.

* `uses-sdk`: Specify the [API versions][apiversionstag] the app is compatible with.
## Review the build configuration

* `uses-permission`: Remove the `android.permission.INTERNET` [permission][permissiontag] if
your application code does not need Internet access. The standard template includes this tag
to enable communication between Flutter tools and a running app.
Review the default [Gradle build file][gradlebuild] file `build.gradle`
located in `<app dir>/android/app/` and verify the values are correct, especially:

* `defaultConfig`:

* `applicationId`: Specify the final, unique (Application Id)[appid]

* `versionCode` & `versionName`: Specify the interall app version number, and
the version number display string. Consult the version information guidance in
the [versions documenation][versions] for details.
Copy link
Contributor

@mravn-google mravn-google Aug 16, 2017

Choose a reason for hiding this comment

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

documentation


* `minSdkVersion` & `targetSdkVersion`: Specify the minimum API level, and the
API level on which the app is designed to run. Consult the API level guidance
in the [versions documenation][versions] for details.
Copy link
Contributor

@mravn-google mravn-google Aug 16, 2017

Choose a reason for hiding this comment

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

Should be referring to API versioning instead?


## Adding a Launcher icon

Expand Down Expand Up @@ -72,7 +87,7 @@ reference to your keystore:
storePassword=<password from previous step>
keyPassword=<password from previous step>
keyAlias=key
storeFile=<location of the key store file, e.g. '/Users/<user name>/key.jks'>
storeFile=<location of the key store file, e.g. /Users/<user name>/key.jks>
```

*Note*: Keep this file private; do not check it into public source control.
Expand Down Expand Up @@ -154,8 +169,8 @@ Google Play Store, see the [Google Play publishing documentation][play].

[manifest]: http://developer.android.com/guide/topics/manifest/manifest-intro.html
[manifesttag]: https://developer.android.com/guide/topics/manifest/manifest-element.html
[appid]: https://developer.android.com/studio/build/application-id.html
[permissiontag]: https://developer.android.com/guide/topics/manifest/uses-permission-element.html
[apiversionstag]: https://developer.android.com/guide/topics/manifest/uses-sdk-element.html
[applicationtag]: https://developer.android.com/guide/topics/manifest/application-element.html
[versions]: https://developer.android.com/studio/publish/versioning.html
[launchericons]: https://developer.android.com/guide/practices/ui_guidelines/icon_design_launcher.html
Expand Down