Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Vlad Chesnokov <vchesnokov@gradle.com>
  • Loading branch information
ov7a authored May 24, 2024
1 parent d5de77d commit 566f2f6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@

# Gradle issue reproducer

This is template repository to create reproducer projects for Gradle issues.
This is a template repository to create reproducer projects for Gradle issues.
The template contains a GitHub Action definition that runs a Gradle build upon each code change.
To quickly learn how it works check the following screencast:
To quickly learn how it works, check the following screencast:

https://user-images.githubusercontent.com/419883/147940456-d0c96c90-f2b5-4574-8133-09647db9545a.mov

## How to use the template

- Fork this repository
- On the main page click the `Use this Template` button
- On the main page, click the `Use this Template` button
- Specify the user/org name and a repository name
- Select `Public` for repository type
- Select `Include all branches`
- Click `Create Repositorty from template`
- Click `Create Repository from template`
- Modify the project in the repository to reproduce the issue
- You can clone your new forked repository locally and push changes, as usual
- You can also edit your reprocer in an online editor by replacing `github.com` with `github.dev` in the URL (or by pressing the '.' key on the keyboard).
- You can also edit your reproducer in an online editor by replacing `github.com` with `github.dev` in the URL (or by pressing the '.' key on the keyboard).
- Adjust the [GitHub Action file](.github/workflows/run-reproducer.yml)
- You can configure the executed Gradle tasks as well as the environment (task options, log level, JVM version, operating system, etc)
- The documentation for the Gradle GitHub Action is available [here](https://github.com/gradle/actions/blob/main/docs/setup-gradle.md)
Expand Down

0 comments on commit 566f2f6

Please sign in to comment.