diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 27360f0b..17af1beb 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -20,16 +20,18 @@ name: Java CI on: push: branches: [master] - pull_request: [master] + pull_request: + branches: [master] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - name: Set up JDK 1.8 + - name: Set up JDK 8 uses: actions/setup-java@v3 with: - java-version: 1.8 + java-version: 8 + distribution: temurin - name: Build with Gradle run: ./gradlew build diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d70bb36..5d330365 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,40 +10,35 @@ Before committing code changes to Apache Pulsar Manager, you need to install req If you have not installed Java and Node, follow the instructions below. -Dependency | Installation guide -|---|--- -Java 8 | https://openjdk.java.net/install/ -Node 10.15 | https://nodejs.org/en/ +| Dependency | Installation guide | +| ---------- | --------------------------------- | +| Java 8 | https://openjdk.java.net/install/ | +| Node 10.15 | https://nodejs.org/en/ | ### Fork pulsar-manager repository Fork the [pulsar-manager](https://github.com/apache/pulsar-manager) repository to your GitHub repository. -### Install pulsar-manager dependency +### Install pulsar-manager dependency 1. Clone pulsar-manager code to your machine. - + ```bash - $ git clone git@github.com:[your-github-id]/pulsar-manager.git + git clone git@github.com:[your-github-id]/pulsar-manager.git ``` 2. Install pulsar-manger dependencies. - - ```bash - $ cd pulsar-manager - - $ ./gradlew build -x test - $ cd front-end - - $ npm install --save + ```bash + cd pulsar-manager + ./gradlew build -x test ``` -## Configure IDE +## Configure IDE Apache Pulsar Manager uses [lombok](https://projectlombok.org/), so set up your IDE with the required plugins. -### Configure Intellij +### Configure Intellij To configure annotation processing in IntelliJ, follow the steps below. @@ -60,35 +55,32 @@ Follow the instructions [here](https://howtodoinjava.com/automation/lombok-eclip ## Contribution workflow 1. Add a remote repository. - + ```bash - $ git remote add apache git@github.com:apache/pulsar-manager.git + git remote add apache git@github.com:apache/pulsar-manager.git ``` 2. Sync you local repository with the remote repository. ```bash - $ git checkout master - $ git pull apache master + git checkout master + git pull apache master ``` 3. Create your PR and commit code changes. ```bash - $ git checkout -b your_branch - - $ git add [your change files] - - $ git commit -m "commit messages" - - $ git push origin your_branch + git checkout -b your_branch + git add [your change files] + git commit -m "commit messages" + git push origin your_branch ``` -> #### Note -> -> Apache Pulsar Manager uses the open-source protocol of Apache License 2.0. +> **Note** +> +> Pulsar Manager is released under Apache License 2.0. > -> If you commit code changes with new files, run the following command to add the license at the beginning of each file. +> If you commit new files, run the following command to add the license header for each file: > > ```bash > ./gradlew licenseFormat @@ -100,8 +92,8 @@ Follow the code styles below to keep code consistent and easy to maintain. Make sure your code looks plain and simple. -Language | Code style guide -|---|--- -Java | https://google.github.io/styleguide/javaguide.html -Vue | https://vuejs.org/v2/style-guide/ +| Language | Code style guide | +| -------- | -------------------------------------------------- | +| Java | https://google.github.io/styleguide/javaguide.html | +| Vue | https://vuejs.org/v2/style-guide/ | diff --git a/build.gradle b/build.gradle index 948f9fd5..af81b41a 100644 --- a/build.gradle +++ b/build.gradle @@ -26,8 +26,7 @@ buildscript { } plugins { - id "com.github.hierynomus.license" version "0.14.0" - id "com.moowork.node" version "1.1.0" + id "com.github.hierynomus.license" version "0.16.1" id "java" id "eclipse" id "idea" diff --git a/gradle.properties b/gradle.properties index 84c05bba..cb0710dd 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ hibernateValidatorVersion=6.0.13.Final jsonWebTokenVersion=0.9.0 jsonWebTokenApiVersion=0.10.5 jsonWebTokenImplVersion=0.10.5 -lombokVersion=1.18.10 +lombokVersion=1.18.26 pageHelperVersion=1.2.4 mockitoVersion=2.8.47 guavaVersion=21.0