Github Actions: add android.yml to build for Android

[leleliu008]

Signed-off-by: leleliu008 [email protected]

[niklasmohrin]

Thank you for contributing! I have some questions about the setup before we can merge this

[niklasmohrin]

Why not just apply the patch and persist that change?

[leleliu008]

Do you mean why not I file a pull request to apply the android.patch?

[niklasmohrin]

Yes, let's just apply the patch and commit these changes instead of having to maintain the patch file

[leleliu008]

I have said in #260

have you read the patch? do you accept this patch file. I'm fairly new to Rust language. I have no ablity to write perfect code in Rust now.

[niklasmohrin]

The patch seems to go in the right direction, not a lot of Rust is required (and we can help you / tell you what to do to fix errors if they come up). Just run patch -p1 < android.patch, remove android.patch and push all of these changes here (if you need git help, feel free to reach out too) :)

[niklasmohrin]

Why do we need to build on mac? It usually takes longer until one gets a mac machine for actions and they are slower than the linux counterparts

[leleliu008]

I can change it to Ubuntu-20.04

[niklasmohrin]

In the other workflow we use ubuntu-latest, so that should do it :)

[niklasmohrin]

I think we can just put this job into the workflow file we already have

[leleliu008]

Ok, I will do it.

[niklasmohrin]

Where does this file come from? It it related to this repository with the same name? I would definitely prefer if we wouldn't have to vendor this script in our repository (and surely not in the root directory)

[leleliu008]

this file is written by me and it is nothing to do with cargo-ndk project

I used to wanna use cargo-ndk project, but it has bugs, and finally I decide to write my own version in shell. It is very simple and readable.

I developed a tool call ndk-pkg, if you want keep the workflow simple, you can use this tool.

name: Ubuntu

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  test:

    runs-on: ubuntu-20.04

    steps:
      - uses: actions/checkout@v2

      - run: curl -LO https://raw.githubusercontent.com/leleliu008/ndk-pkg/master/bin/ndk-pkg

      - run: chmod +x ndk-pkg

      - run: ./ndk-pkg update

      - name: create formula
        run:  |
          cat > ~/.ndk-pkg/repos.d/offical/formula/tealdeer.sh << EOF
          package set summary "Very fast implementation of tldr in Rust"
          package set git.url "https://github.com/dbrgn/tealdeer.git"
          package set src.url "dir://${{ github.workspace }}"
          package set license "Apache-2.0"
          package set dep.pkg "openssl"
          package set bsystem "cargo"
          EOF

      - run: ./ndk-pkg install tealdeer --tree

[leleliu008]

I have port this project to ndk-pkg, here is a github action example https://github.com/leleliu008/ndk-pkg-formula-repository/runs/4992613697?check_suite_focus=true

[niklasmohrin]

Ah that looks interesting 👍 If you have the tealdeer formula in your package base, we don't need to run cargo-ndk here, right? I am happy with applying the android.patch and committing this here, so you don't need to patch the code in the formula. Additionally, we can run a standard cargo build for the android target in CI so that it doesn't break out of the blue (testing is harder). Does that sound good to you?

[leleliu008]

If you have the tealdeer formula in your package base, we don't need to run cargo-ndk here, right?

In my ndk-pkg formula repo, I use the stable tarball file https://github.com/dbrgn/tealdeer/archive/v1.5.0.tar.gz , not fetch from the github source tree HEAD

we can run a standard cargo build for the android target in CI so that it doesn't break out of the blue (testing is harder).

just run cargo build --target armv7-linux-androideabi is not enough. some certain environment variables must be set, that's why I wrote cargo-ndk.sh.

[niklasmohrin]

I must admit, I am not comfortable with cargo-ndk, this just adds too much code to maintain to this repository. In #274, I noted that there is the possibility of using cross which cross-compiles using docker containers. This works great, bat uses it, I use it in another project and it is very easy to use with the actions-rs/cargo action we already use. About the compile error from the issue: We should just remove this function altogether, because the Other variant does not exist anyways

[dbrgn]

In #274, I noted that there is the possibility of using cross which cross-compiles using docker containers.

Does that just build for ARM, or actually on an Android device?

[niklasmohrin]

You can choose any of the rust targets (for example this list), we would probably be most interested in aarch64-linux-android and friends. If I understand it correctly, cross uses a docker container for cross compiling and qemu to run tests - or maybe they also compile in qemu. If we just build without testing, we don't need to worry about any ndk stuff, otherwise, we may have to a little bit of code to hook into that. I don't really know anything about android development, but that's just another reason why I don't want to host these specifics in our repo :D

[niklasmohrin]

@leleliu008 Do you want to continue working on this, or should we close this PR for now?

[leleliu008]

Since the feature has been implemented in #274, this is no need to go on. Please feel free to close it.