Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xvik committed Apr 13, 2024
1 parent 14890fe commit 49b7bc5
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
### 4.0.0 (2024-04-13)
* (breaking) Drop gradle 5 and 6 support
* (breaking) All plugin tasks become abstract, so any custom task types should be abstract too
* (breaking) All tasks use lazy properties instead of convention mapping (affects custom tasks)
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Features:

* Works with directly installed python or docker container (with python)
* Creates local (project-specific) virtualenv (project-specific python copy)
* Installs required pip modules (virtualenv by default, but could be global installation)
* Installs required pip modules (venv by default (with fallback to virtualenv), but could be global installation)
* Support requirements.txt file (limited by default)
* Compatible with gradle configuration cache
* Could be used as basement for building plugins for specific python modules (like
[mkdocs plugin](https://github.com/xvik/gradle-mkdocs-plugin))

Expand Down Expand Up @@ -52,7 +53,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'ru.vyarus:gradle-use-python-plugin:3.0.0'
classpath 'ru.vyarus:gradle-use-python-plugin:4.0.0'
}
}
apply plugin: 'ru.vyarus.use-python'
Expand All @@ -62,18 +63,20 @@ OR

```groovy
plugins {
id 'ru.vyarus.use-python' version '3.0.0'
id 'ru.vyarus.use-python' version '4.0.0'
}
```

#### Compatibility

Plugin compiled for java 8, compatible with java 11. Supports python 2 and 3 on windows and linux (macos).
Plugin compiled for java 8, compatible with java 11, 17.
Supports python 2 (not tested anymore, but should work) and 3 on windows and linux (macos)

Gradle | Version
--------|-------
5.3-8 | 3.0.0
5-5.2 | 2.3.0
7.0 | 4.0.0
5.3 | [3.0.0](https://xvik.github.io/gradle-use-python-plugin/3.0.0/)
5-5.2 | [2.3.0](https://xvik.github.io/gradle-use-python-plugin/2.3.0/)
4.x | [1.2.0](https://github.com/xvik/gradle-use-python-plugin/tree/1.2.0)

#### Snapshots
Expand Down
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ github {

mkdocs {
extras = [
'version': '3.0.0',
'image': 'python:3.10.8-alpine3.15'
'version': '4.0.0',
'image': 'python:3.11.8-alpine3.19'
]
publish {
docPath = mkdocs.extras['version']
Expand Down
4 changes: 2 additions & 2 deletions src/doc/docs/about/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Works with python 2 and 3 (but python 2 not tested anymore) on windows and linux
Gradle | Version
--------|-------
7.0 | 4.0.0
5.3 | 3.0.0
5-5.2 | 2.3.0
5.3 | [3.0.0](https://xvik.github.io/gradle-use-python-plugin/3.0.0/)
5-5.2 | [2.3.0](https://xvik.github.io/gradle-use-python-plugin/2.3.0/)
4.x | [1.2.0](https://github.com/xvik/gradle-use-python-plugin/tree/1.2.0)

0 comments on commit 49b7bc5

Please sign in to comment.