Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bitrise-steplib/steps-gradle-runner

https://github.com/bitrise-steplib/steps-gradle-runner

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary

Keywords

bitrise bitrise-step ci hacktoberfest production-code
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: bitrise-steplib
  • License: mit
  • Language: Go
  • Default Branch: master
  • Homepage:
  • Size: 780 KB
Statistics
  • Stars: 10
  • Watchers: 12
  • Forks: 27
  • Open Issues: 3
  • Releases: 49
Topics
bitrise bitrise-step ci hacktoberfest production-code
Created over 10 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

Gradle Runner

Step changelog

Runs a specified Gradle task.

Description The Step runs the specified Gradle task and copies the generated APK and AAB files into the Bitrise Deploy Directory (`$BITRISE_DEPLOY_DIR`). It is capable of doing everything that you can do with Gradle on your own machine. ### Configuring the Step To use this Step, you need at least two things: * [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html). * A Gradle task that is correctly configured in your Gradle project. The Step can run the specified task with the Gradle Wrapper. For the basic configuration: 1. Open the **Config** input group. 1. In the **Gradle task to run** input, add the task you want to run. Without an existing, valid task, the Step will fail. 1. Set the `gradlew` file path: this is the path where the Gradle Wrapper lives in your project. The path should be relative to the project's root. To configure exporting an APK or AAB file generated by the Step: 1. Open the **Export config** input group. 1. Filter the files you want the Step to export. You can filter: * APK and AAB files. * Test APK files. * Mapping files. Both exclude and include filters can be used. Each filter option can take multiple patterns, with each pattern on its own line in the input field. ### Troubleshooting If the Step keeps failing because it can't download the dependencies, check the `repositories` section in your `build.gradle` file. It's possible that one or more of the services listed there are down so we Bitrise can't connect to them to download the dependencies you need. If you use a `build.gradle` file and get the error `Issue with input: GradleFile does not exist`, check the **Optional path to the gradle build file to use** input. Remember, the path must be relative to the root of the repository. ### Useful links * [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) * [Caching Gradle](https://devcenter.bitrise.io/builds/caching/caching-gradle/) ### Related Steps * [Generate Gradle Wrapper](https://www.bitrise.io/integrations/steps/generate-gradle-wrapper) * [Gradle Unit Test](https://www.bitrise.io/integrations/steps/gradle-unit-test) * [Android Build](https://www.bitrise.io/integrations/steps/android-build)

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

Examples

This configuration builds all variant's aab:

yaml - gradle-runner@2: inputs: - gradlew_path: "./gradlew" - gradle_task: bundleRelease You can also set up file path filters to avoid exporting unwanted archives or mapping files:

yaml - gradle-runner@2: inputs: - gradlew_path: "./gradlew" - gradle_task: bundleRelease - app_file_include_filter: "*release.aab" - app_file_exclude_filter: "*/temporary/*" - test_apk_file_include_filter: "*Test*.apk" - test_apk_file_exclude_filter: "*/immediate/*" - mapping_file_include_filter: "*/mapping.txt" - mapping_file_exclude_filter: "*/tmp/*"

⚙️ Configuration

Inputs | Key | Description | Flags | Default | | --- | --- | --- | --- | | `build_root_directory` | The root directory of the Gradle project where the gradlew file and build.gradle are located. This can be either a relative path (relative to the working directory) or an absolute path. For example, if your Android project is in a subdirectory called `android`, set this to `./android`. | | `.` | | `gradle_task` | Gradle task to run. You can call `gradle tasks` or `gradle tasks --all` in your Gradle project directory to get the list of available tasks. | required | `assemble` | | `gradlew_path` | Using a Gradle Wrapper (gradlew) is required, as the wrapper ensures that the right Gradle version is installed and used for the build. You can find more information about the Gradle Wrapper (gradlew), and about how you can generate one in the official guide at: [https://docs.gradle.org/current/userguide/gradle_wrapper.html](https://docs.gradle.org/current/userguide/gradle_wrapper.html). The path should be relative to the build_root_directory input. For example, `./gradlew`, or if it is in a sub directory, `./sub/dir/gradlew`. | required | `./gradlew` | | `app_file_include_filter` | The Step will copy the generated APK and AAB files that match this filter into the Bitrise deploy directory. Seperate patterns with a newline. Example: Copy every APK and AAB file: ``` *.apk *.aab ``` Copy every APK file with a filename that contains `release`, like (`./app/build/outputs/apk/app-release-unsigned.apk`): ``` *release*.apk ``` | | `*.apk *.aab ` | | `app_file_exclude_filter` | One filter per line. The Step will NOT copy the generated APK and AAB files that match these filters into the Bitrise deploy directory. You can use this filter to avoid moving unaligned and/or unsigned APK and AAB files. If you specify an empty filter, every APK and AAB file (selected by `APK and AAB file include filter`) will be copied. Seperate patterns with a newline. Examples: Do not copy APK files with a filename that contains `unaligned`: ``` *unaligned*.apk ``` Do not copy APK files with a filename that contains `unaligned` and/or `Test`: ``` *unaligned*.apk *Test*.apk ``` | | `*unaligned.apk *Test*.apk */intermediates/* ` | | `test_apk_file_include_filter` | The Step will copy the generated apk files that match this filter into the Bitrise deploy directory. Example: Copy every APK if its filename contains Test, like (./app/build/outputs/apk/app-debug-androidTest-unaligned.apk): ``` *Test*.apk ``` | | `*Test*.apk` | | `test_apk_file_exclude_filter` | One filter per line. The Step will NOT copy the generated apk files that match this filters into the Bitrise deploy directory. You can use this filter to avoid moving unalinged and/or unsigned apk files. If you specify an empty filter, every APK file (selected by `apk_file_include_filter`) will be copied. Example: Do not copy the test APK file if its filename contains `unaligned`: ``` *unaligned*.apk ``` | | | | `mapping_file_include_filter` | The Step will copy the generated mapping files that match this filter into the Bitrise deploy directory. If you specify an empty filter, no mapping files will be copied. Example: Copy every mapping.txt file: ``` *mapping.txt ``` | | `*/mapping.txt` | | `mapping_file_exclude_filter` | The Step will **not** copy the generated mapping files that match this filter into the Bitrise deploy directory. You can use this input to avoid moving a beta mapping file, for example. If you specify an empty filter, every mapping file (selected by `mapping_file_include_filter`) will be copied. Example: Do not copy any mapping.txt file that is in a `beta` directoy: ``` */beta/mapping.txt ``` | | `*/tmp/*` | | `cache_level` | `all` - will cache build-cache and dependencies `only_deps` - will cache dependencies only `none` - won't cache any of the above | required | `only_deps` | | `gradle_options` | Flags added to the end of the Gradle call. You can use multiple options, separated by a space. Example: `--stacktrace --debug` If `--debug` or `-d` options are set then only the last 20 lines of the raw gradle output will be visible in the build log. The full raw output will be exported to the `$BITRISE_GRADLE_RAW_RESULT_TEXT_PATH` variable and will be added as a build artifact. | | `--stacktrace` |
Outputs | Environment Variable | Description | | --- | --- | | `BITRISE_APK_PATH` | This output will include the path of the generated APK file, after filtering based on the filter inputs. If the build generates more than one APK file which fulfills the filter inputs this output will contain the last one's path. | | `BITRISE_AAB_PATH` | This output will include the path of the generated AAB file, after filtering based on the filter inputs. If the build generates more than one AAB file which fulfills the filter inputs this output will contain the last one's path. | | `BITRISE_TEST_APK_PATH` | This output will include the path of the generated test APK file, after filtering based on the filter inputs. If the build generates more than one APK file which fulfills the filter inputs this output will contain the last one's path. | | `BITRISE_APK_PATH_LIST` | This output will include the paths of the generated APK files, after filtering based on the filter inputs. The paths are separated with `\|` character, eg: `app-armeabi-v7a-debug.apk\|app-mips-debug.apk\|app-x86-debug.apk` | | `BITRISE_AAB_PATH_LIST` | This output will include the paths of the generated AAB files, after filtering based on the filter inputs. The paths are separated with `\|` character, eg: `app.aab\|app2.aab` | | `BITRISE_MAPPING_PATH` | This output will include the path of the generated mapping.txt. If more than one mapping.txt exist in project this output will contain the last one's path. |

🙋 Contributing

We welcome pull requests and issues against this repository.

For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.

Learn more about developing steps:

Owner

  • Name: bitrise-steplib
  • Login: bitrise-steplib
  • Kind: organization

GitHub Events

Total
  • Create event: 7
  • Release event: 1
  • Issues event: 2
  • Delete event: 3
  • Issue comment event: 5
  • Push event: 13
  • Pull request review comment event: 2
  • Pull request review event: 6
  • Pull request event: 8
Last Year
  • Create event: 7
  • Release event: 1
  • Issues event: 2
  • Delete event: 3
  • Issue comment event: 5
  • Push event: 13
  • Pull request review comment event: 2
  • Pull request review event: 6
  • Pull request event: 8

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 151
  • Total Committers: 25
  • Avg Commits per committer: 6.04
  • Development Distribution Score (DDS): 0.682
Past Year
  • Commits: 4
  • Committers: 2
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.25
Top Committers
Name Email Commits
Tamas Papik t****a@g****m 48
Viktor Benei v****i@g****m 24
Krisztian Godrei g****n@g****m 20
Olivér Falvai o****i@b****o 11
Krisztián Gödrei g****n@g****m 9
birmacher b****r@g****m 7
Mate Herber m****r@b****o 4
Krisztian d****n@g****m 4
lszucs 4****s 3
Krisztian Dobmayer k****r@b****o 2
Karol Wrótniak k****k@d****l 2
lpusok 7****k 2
renovate[bot] 2****] 2
zoltan-baba z****a@b****o 2
Adam Borbas a****s 1
Akos Birmacher 3****s 1
Bitrise CoreSteps Bot 7****t 1
Radim Vaculik r****k@g****m 1
Rajiv Shah r****1@i****m 1
Sandor Feher 4****e 1
Szabados Áron a****s@b****o 1
Selcuk Bulca s****k@m****m 1
Tamás Kádár k****s@k****m 1
daniCsorba 9****a 1
Maciek Janusz m****z@g****m 1
Committer Domains (Top 20 + Academic)
bitrise.io: 5 ktamas.com: 1 mobilike.com: 1 droidsonroids.pl: 1 gmil.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 38
  • Total pull requests: 71
  • Average time to close issues: 3 months
  • Average time to close pull requests: 13 days
  • Total issue authors: 32
  • Total pull request authors: 22
  • Average comments per issue: 5.13
  • Average comments per pull request: 0.28
  • Merged pull requests: 65
  • Bot issues: 1
  • Bot pull requests: 2
Past Year
  • Issues: 1
  • Pull requests: 4
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 9 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • viktorbenei (3)
  • bootstraponline (2)
  • julo15 (2)
  • scruffyfox (2)
  • G00fY2 (2)
  • brinkkemper (1)
  • fedesenmartin (1)
  • radimvaculik (1)
  • anish-gupta89 (1)
  • kshitizshakya-cc (1)
  • amatkivskiy (1)
  • renovate[bot] (1)
  • renatobenks-zz (1)
  • DSteve595 (1)
  • nowele-rechka-entercom (1)
Pull Request Authors
  • ofalvai (16)
  • trapacska (14)
  • godrei (10)
  • lpusok (4)
  • mateherber (4)
  • renovate[bot] (3)
  • lszucs (3)
  • viktorbenei (3)
  • BirmacherAkos (2)
  • zoltan-baba (2)
  • koral-- (2)
  • kdobmayer (2)
  • rajivshah3 (1)
  • maciekjanusz (1)
  • bitrise-coresteps-bot (1)
Top Labels
Issue Labels
stale (5) question (4) enhancement (3) bug (3) duplicate (1)
Pull Request Labels
renovate (2) renovate-swat (2)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
proxy.golang.org: github.com/bitrise-steplib/steps-gradle-runner
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago

Dependencies

go.mod go
  • github.com/bitrise-io/go-android v0.0.0-20210527143215-3ad22ad02e2e
  • github.com/bitrise-io/go-steputils v0.0.0-20210527075147-910ce7a105a1
  • github.com/bitrise-io/go-utils v0.0.0-20210713111255-08be784d45d0
  • github.com/hashicorp/go-cleanhttp v0.5.2
  • github.com/hashicorp/go-retryablehttp v0.7.0
  • github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
  • github.com/ryanuber/go-glob v1.0.0
go.sum go
  • github.com/bitrise-io/go-android v0.0.0-20210527143215-3ad22ad02e2e
  • github.com/bitrise-io/go-steputils v0.0.0-20210514150206-5b6261447e77
  • github.com/bitrise-io/go-steputils v0.0.0-20210527075147-910ce7a105a1
  • github.com/bitrise-io/go-utils v0.0.0-20210507100250-37de47dfa6ce
  • github.com/bitrise-io/go-utils v0.0.0-20210520073355-367fa34178f5
  • github.com/bitrise-io/go-utils v0.0.0-20210713111255-08be784d45d0
  • github.com/davecgh/go-spew v1.1.0
  • github.com/davecgh/go-spew v1.1.1
  • github.com/hashicorp/go-cleanhttp v0.5.1
  • github.com/hashicorp/go-cleanhttp v0.5.2
  • github.com/hashicorp/go-hclog v0.9.2
  • github.com/hashicorp/go-retryablehttp v0.6.6
  • github.com/hashicorp/go-retryablehttp v0.7.0
  • github.com/hashicorp/go-version v1.3.0
  • github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
  • github.com/pmezard/go-difflib v1.0.0
  • github.com/ryanuber/go-glob v1.0.0
  • github.com/stretchr/objx v0.1.0
  • github.com/stretchr/objx v0.3.0
  • github.com/stretchr/testify v1.2.2
  • github.com/stretchr/testify v1.3.0
  • github.com/stretchr/testify v1.5.1
  • github.com/stretchr/testify v1.7.0
  • golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2
  • golang.org/x/crypto v0.0.0-20200220183623-bac4c82f6975
  • golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a
  • golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3
  • golang.org/x/net v0.0.0-20210226172049-e18ecbb05110
  • golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a
  • golang.org/x/sys v0.0.0-20190412213103-97732733099d
  • golang.org/x/sys v0.0.0-20200219091948-cb0a6d8edb6c
  • golang.org/x/sys v0.0.0-20201119102817-f84b799fce68
  • golang.org/x/sys v0.0.0-20210511113859-b0526f3d8744
  • golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1
  • golang.org/x/term v0.0.0-20210503060354-a79de5458b56
  • golang.org/x/text v0.3.0
  • golang.org/x/text v0.3.3
  • golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e
  • gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405
  • gopkg.in/yaml.v2 v2.2.2
  • gopkg.in/yaml.v2 v2.2.8
  • gopkg.in/yaml.v2 v2.4.0
  • gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c
  • gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
.github/workflows/stale-issues-workflow.yml actions
  • actions/stale v3 composite
  • dessant/lock-threads v2 composite
  • jakejarvis/wait-action master composite