chesire / eden

Template repository for Android projects. Provides multiple pre-setup tools and configurations. See README for more information.

eden's Issues

Upload test results artifact

Add a stage to CI to upload the test results as an artifact.
This could then be used by Danger to produce warnings if need be.

Require test and analyze to run Danger on CI

Since the Danger step downloads the test results and the lint results, it should require both.

Add fetch-depth for Danger job

The Danger job can fail if there isn't a fetch-depth due to some issues with how it gets a shallow clone. Source danger/issues/913.

Changing the Danger job to have

    - uses: actions/checkout@v2
      with:
        fetch-depth: 100

should fix the issue

Add CONTRIBUTING.md

There is no default CONTRIBUTING.md in the repo, one should be added.

Add base gradle files to deploy to bintray

Based on the changes in Chesire/LintRules#94 it should be easy to add some base files to deploy to bintray. Just having to fill in the ext block.

Move configuration into different folder

All of the configuration files are currently in the root of the repo, moving them into a .config or similar would make the repository a bit cleaner

Add code coverage generation

Add ability to generate code coverage as jacoco reports.
Add uploading this to codecov via the github actions.

Add ci stage to run ui tests

Look at adding stage to run UI tests, they should be run on the Firebase test lab if possible

Run ktlint on pre-push

Ensure code is compliant with ktlint before pushing, can be added to the husky scripts

Make Danger check for default pull request descriptions

Update Danger so it checks the pull request description, and if it matches a known template then thrown an error.

Add default github issues

Add a file to set some default issues and settings for creating new issues in a repo.

Maybe add Android studio template with a script

Add a template engine with a script that provides the name, this is so that it can all be setup correctly with the .gitignore and build.gradle files existing.

Creating new AndroidStudio project doesn't add files

It looks like creating an android studio project is now broken, need to update to get this working again.

Add Jacoco example

Add an example gradle file for Jacoco, much like detekt and ktlint samples.

Find way to make detekt run over whole project

Instead of having the user update the detekt settings for each module, find way to add every module automatically.

Add deploy stage to CI

Add something to the github actions so that there is a sample deploy stage. As part of this, the readme should be updated to mention to add the required secrets.

  deploy:
    if: startsWith(github.ref, 'refs/tags/*')
    needs: [test, analyze]
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: set up JDK 1.8
      uses: actions/[email protected]
      with:
        java-version: 1.8
    - name: Fetch tags
      run: git fetch origin 'refs/tags/*:refs/tags/*'
    - name: run assembleDebug
      run: ./gradlew assembleDebug
    - name: Set env
      run: echo ::set-env name=RELEASE_VERSION::${GITHUB_REF#refs/*/}
    - name: Deploy
      run: ./gradlew bintrayUpload -PbintrayUser=${{ secrets.BINTRAY_USER_ID }} -PbintrayKey=${{ secrets.BINTRAY_API_KEY }} -PpublishVersion=${{ env.RELEASE_VERSION }} -PdryRun=false

Change from using Danger action

Remove the usage of the Danger action, and instead run Danger manually.

    - uses: actions/[email protected]
      with:
        ruby-version: '2.6'
    - uses: actions/[email protected]
      with:
        path: vendor/bundle
        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
        restore-keys: |
          ${{ runner.os }}-gems-
    - name: bundle install
      run: |
        gem install bundler
        bundle config path vendor/bundle
        bundle install --without=documentation --jobs 4 --retry 3
    - name: danger
      run: bundle exec danger
      env:
        DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}

Make CI build master

Currently CI only builds on branches, it would be beneficial if it ran on master as well.

Add more Danger items

More items could be used with Danger to report failures.
JUnit failures could be reported on the PR for when tests are skipped or failed.
Markdown could be validated to ensure there are no errors.