Skip to content
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

release: Preparing release 1.0.0 #11

Merged
merged 1 commit into from
Mar 25, 2024
Merged

release: Preparing release 1.0.0 #11

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
5 changes: 3 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [1.0.0] - 2024-03-25
### Added
- Extracting Besu custom error-prone checks to its own repository
- Extracting Besu custom error-prone checks to its own repository
- Added Github Actions for CI/CD
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,18 @@
This repository contains custom error-prone checks for [Hyperledger Besu](https://github.com/hyperledger/besu/).

## Usage
These [custom error-prone checks](https://errorprone.info/docs/plugins) are used in the Besu codebase. To use these checks in your project, you can add the following dependency to your gradle file:
These [custom error-prone checks](https://errorprone.info/docs/plugins) are used in the Besu codebase. To use these checks in your project:

1. Add the following repository definition to your gradle file:
```groovy
repositories {
maven {
url 'https://hyperledger.jfrog.io/hyperledger/besu-maven'
content { includeGroupByRegex('org\\.hyperledger\\..*') }
}
}
```
2. Add the following dependency to your gradle file:
```groovy
dependencies {
errorprone("org.hyperledger.errorpronechecks:besu-errorprone-checks:1.0.0")
Expand All @@ -22,4 +32,4 @@ The creation of custom errorprone checkers was largely derived from:
To allow for debugging from within intellij, the following must be added to the VM args
in the run/debug configuration (this assumes your gradle cache is at the default location under
your home):
-Xbootclasspath/p:${HOME}/.gradle/caches/./modules-2/files-2.1/com.google.errorprone/javac/9+181-r4173-1/bdf4c0aa7d540ee1f7bf14d47447aea4bbf450c5/javac-9+181-r4173-1.jar
`-Xbootclasspath/p:${HOME}/.gradle/caches/./modules-2/files-2.1/com.google.errorprone/javac/9+181-r4173-1/bdf4c0aa7d540ee1f7bf14d47447aea4bbf450c5/javac-9+181-r4173-1.jar`
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version=0.1.5
version=1.0.0

org.gradle.welcome=never

Expand Down