Skip to content

Revert "Add support for custom URL templates (#202)" #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryanulep wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revert "Add support for custom URL templates (#202)" #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,21 +207,6 @@ detekt.detekt_version(
use_repo(detekt, "detekt_cli_all")
```

To download Detekt from a custom location (e.g. an internal mirror), use the `url_templates` parameter:

```python
detekt = use_extension("@rules_detekt//detekt:extensions.bzl", "detekt")
detekt.detekt_version(
version = "...",
sha256 = "...",
url_templates = [
"https://my-mirror.example.com/detekt/detekt-cli-{version}-all.jar",
],
)

use_repo(detekt, "detekt_cli_all")
```

#### `WORKSPACE` Configuration

```python
Expand All @@ -236,22 +221,6 @@ rules_detekt_dependencies(
)
```

To download Detekt from a custom location (e.g., an internal mirror), use the `url_templates` parameter:

```python
rules_detekt_dependencies(
detekt_version = detekt_version(
version = "...",
sha256 = "...",
url_templates = [
"https://my-mirror.example.com/detekt/detekt-cli-{version}-all.jar",
],
)
)
```

Each template may contain `{version}` which will be replaced with the version string.

### JVM Flags

The default toolchain uses `-Xms16m -Xmx128m`. To customize JVM flags, define your own toolchain
Expand Down
7 changes: 1 addition & 6 deletions detekt/extensions.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ _version_tag = tag_class(
attrs = {
"version": attr.string(mandatory = True),
"sha256": attr.string(mandatory = True),
"url_templates": attr.string_list(),
},
)

Expand All @@ -32,11 +31,7 @@ def _detekt_impl(mctx):
for override in mod.tags.detekt_version:
if detekt_version:
fail("Only a single detekt_version at once is supported right now!")
detekt_version = _detekt_version(
version = override.version,
sha256 = override.sha256,
url_templates = override.url_templates if override.url_templates else None,
)
detekt_version = _detekt_version(version = override.version, sha256 = override.sha256)

kwargs = dict(detekt = _DEFAULT_DETEKT_RELEASE)
if detekt_version:
Expand Down
13 changes: 4 additions & 9 deletions detekt/versions.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
"""Macro for defining detekt versions.
"""

_DEFAULT_URL_TEMPLATES = [
"https://github.com/detekt/detekt/releases/download/v{version}/detekt-cli-{version}-all.jar",
]

def detekt_version(version, sha256, url_templates = None):
def detekt_version(version, sha256):
"""Create a detekt version.

Args:
version (str): The version of detekt.
sha256 (str): The sha256 of the detekt jar.
url_templates (list, optional): URL templates for downloading detekt. Each template
may contain `{version}` which will be replaced with the version string.
Defaults to the standard GitHub release URL.

Returns: A struct containing the version information.
"""
return struct(
version = version,
sha256 = sha256,
url_templates = url_templates if url_templates != None else _DEFAULT_URL_TEMPLATES,
url_templates = [
"https://github.com/detekt/detekt/releases/download/v{version}/detekt-cli-{version}-all.jar",
],
)

DEFAULT_DETEKT_RELEASE = detekt_version(
Expand Down
Loading