Update documentation for public release

[vincentbrison]

To be able to properly put the project in open source, we should work on the documentation:

• Update README
• Add a contributing guide https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors#adding-a-contributing-file
• Automate release note (https://github.com/github-changelog-generator/github-changelog-generator)

[sjcqs]

Badge for snapshot release:

![Build test and deploy snapshot images](https://github.com/faberNovel/docker-android/workflows/Build%20test%20and%20deploy%20snapshot%20images/badge.svg)

[vincentbrison]

About image documentation:
We should add a script which is able to be run by an image to describe the image. For instance, it could print:

• All packages installed with their version, from apt
• rbenv version, default ruby env, all gems installed and their version from default ruby env
• java version
• Android API version, Android NDK version

When a release is published, GitHub Action would generate a Changelog.md using standard tools as https://github.com/github-changelog-generator/github-changelog-generator, and would also commit images descriptions using script described ahead.

Those files could also be attached to GitHub Release to be able to have a quick look at whats available.

In a second time we could take a look at automate creation of draft GitHub release, which would trigger all tasks described above, without commit the files, to be sure everything is fine, when a branch like releases/v* is open. Then we would only allow manual publish using GitHub interface from those draft release.

What do you think about that @sjcqs ?

[sjcqs]

Seems good to me. Generated file should be in markdown format (a table maybe) to facilitate formatting. Maybe for the publish part: - Triggered when a branch release/v* is created - Check the sementic version of the branch - Commit the changes - Create a PR to master that we have to manually check and merge On merging a PR from release/v*: - Create a github release -

…

On Tue, Apr 21, 2020 at 11:21 AM Vincent Brison ***@***.***> wrote: About image documentation: We should add a script which is able to be run by an image to describe the image. For instance, it could print: - All packages installed with their version, from apt - rbenv version, default ruby env, all gems installed and their version from default ruby env - java version - Android API version, Android NDK version When a release is published, GitHub Action would generate a Changelog.md using standard tools as https://github.com/github-changelog-generator/github-changelog-generator, and would also commit images descriptions using script described ahead. Those files could also be attached to GitHub Release to be able to have a quick look at whats available. In a second time we could take a look at automate creation of draft GitHub release, which would trigger all described above, without commit, to be sure everything is fine, when a branch like releases/v* is open, and only publish the release manually with GitHub interface? What do you think about that @sjcqs <https://github.com/sjcqs> ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#27 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AETI6BREIH2NDB6PY72GD3TRNVQSFANCNFSM4MMNG5MQ> .

[vincentbrison]

Seems good to me, will look into it.

[vincentbrison]

Depend on #29

[vincentbrison]

Still need to create an action to:

• on release/** PR merged
• deploy images
• create release

cd_release.yml should be updated according this

[vincentbrison]

All above is done. Still need to add sample on GitHub Action integration, and some cleanup in readme.