Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

Commit

Permalink
Make the main README more informative (#14)
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Ingeman-Nielsen <[email protected]>
  • Loading branch information
michaelin and Michael Ingeman-Nielsen authored Mar 17, 2020
1 parent 5e3bd1c commit 4868c53
Showing 1 changed file with 58 additions and 24 deletions.
82 changes: 58 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,85 @@

![alt-text](https://jaxenter.com/wp-content/uploads/2016/06/Screen-Shot-2016-06-06-at-2.56.13-PM.png "Gradle logo")

### Learn Gradle with these interactive katas
## Quick start

Task creation
- task-creation - Add a simple task and execute it
### In the Cloud

- build-phases - Creating dependent tasks and ordered execution
[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/praqma-training/gradle-katas.git)

### On Your Local Machine

Properties
- configuring-properties - Different ways of passing properties to the build
You need to have Java and Gradle installed to run these katas. Follow the intallation guides for each product:

- checking-properties - Verifying and using passed properties
- **Java**: [adoptopenjdk.net](https://adoptopenjdk.net/)
- **Gradle**: [gradle.org](https://gradle.org/install/)

Task Flow
- task-execution-order - Instructing your tasks to run in certain order
You can check your installation with the following command:
```
$ gradle -version
- task-dependencies - Creating a DAG (directed acyclic graph) out of your tasks
------------------------------------------------------------
Gradle 6.1
------------------------------------------------------------
...
```

To work through the katas, you need to clone this repository locally.
For each exercise, you will then

Skipping task
- incremental-tasks - Defining build-input and output
- Go into the folder with the exrecise you want to work on
- Run the `setup.sh` script
- Consult the README.md in that folder to get a description of the exercise

- skipping-execution - Conditional execution of tasks
These katas are designed to run under Bash, so they should be straight forward to run on MacOS or most commont Linux distributions.
For windows users, we recommend using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10).

## Purpose of Gradle Katas

Task types
- built-in-task-types - Experiment with a variety of built-in types
This repository is a collection of Gradle exercises.
The concept is stolen without shame from [Schauderhaft.de](http://blog.schauderhaft.de/gitkata/).

The exercises are designed for use when we are teaching Gradle courses. You should be able to use them as self-contained exercises that will allow you to keep your Gradle skills sharp.

- custom-task-types - Defining custom re-usable types.
Feel free to use these exercises, that's why they're public!

## Suggested Learning Path

Task creation
- [task-creation](./task-creation/README.md) - Add a simple task and execute it
- [build-phases](./build-phases/README.md) - Creating dependent tasks and ordered execution

Properties
- [configuring-properties](./configuring-properties/README.md) - Different ways of passing properties to the build
- [checking-properties](./checking-properties/README.md) - Verifying and using passed properties

Task Flow
- [task-execution-order](./task-execution-order/README.md) - Instructing your tasks to run in certain order
- [task-dependencies](./task-dependencies/README.md) - Creating a DAG (directed acyclic graph) out of your tasks


Skipping task
- [incremental-tasks](./incremental-tasks/README.md) - Defining build-input and output
- [skipping-execution](./skipping-execution/README.md) - Conditional execution of tasks


Task types
- [built-in-task-types](./built-in-task-types/README.md) - Experiment with a variety of built-in types
- [custom-task-types](./custom-task-types/README.md) - Defining custom re-usable types.


Plugin
- applying-plugins - Looking into available plugins
- [applying-plugins](./applying-plugins/README.md) - Looking into available plugins


Task rules and dynamic tasks
- task-rules - Dynamic task content

- dynamic-task-creation
- [task-rules](./task-rules/README.md) - Dynamic task content
- [dynamic-task-creation](./dynamic-task-creation/README.md)


Artifact handling
- publish-artifact - How to share your artifact. Group, name and version practices.

- resolve-artifact - Compile code using the artifact as a dependency
- [publish-artifact](./publish-artifact/README.md) - How to share your artifact. Group, name and version practices.
- [resolve-artifact](./resolve-artifact/README.md) - Compile code using the artifact as a dependency

Extras
- promoting-artifacts-example
- [promoting-artifacts-example](./promoting-artifacts-example/README.md)

0 comments on commit 4868c53

Please sign in to comment.