Skip to content

Commit

Permalink
Polish markdown files
Browse files Browse the repository at this point in the history
Signed-off-by: Taeik Lim <[email protected]>
  • Loading branch information
acktsap authored Feb 3, 2025
1 parent 0b7cfc5 commit b89c08e
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 59 deletions.
8 changes: 4 additions & 4 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ trim_trailing_whitespace = true
# [indentation-tab]
indent_style = space

# [2-spaces-tab]
indent_size = 2
tab_width = 2
# [4-spaces-tab]
indent_size = 4
tab_width = 4

# [no-trailing-spaces]
trim_trailing_whitespace = true
trim_trailing_whitespace = true
31 changes: 1 addition & 30 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# ChangeLog

- [1.1.x](#11x)
- [1.1.0-SNAPSHOT](#110-snapshot)
- [1.1.0](#110)
- [1.0.x](#10x)
- [1.0.2-SNAPSHOT](#102-snapshot)
- [1.0.1](#101)
- [1.0.0](#100)
- [0.3.x](#03x)
Expand All @@ -16,20 +15,6 @@

## 1.1.x

### 1.1.1-SNAPSHOT

#### New Features

- None

#### Changes

- None

#### Bug fixes & Improvements

- None

### 1.1.0

#### New Features
Expand All @@ -51,20 +36,6 @@

## 1.0.x

### 1.0.2-SNAPSHOT

#### New Features

- None

#### Changes

- None

#### Bug fixes & Improvements

- None

### 1.0.1

#### New Features
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,14 +169,14 @@ Java
## User Guide

- 1.1.x
- [Korean](https://github.com/naver/spring-batch-plus/tree/main/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/main/doc/en)
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.1.x/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/1.1.x/doc/en)
- 1.0.x
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/en)
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/en)
- 0.3.x
- [Korean](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/en)
- [Korean](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/ko)
- [English](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/en)

## Build from source

Expand All @@ -189,7 +189,7 @@ Java

- Clean: `./gradlew clean`
- Check: `./gradlew check`
- Coverage report will be generated in `${project}/build/jacoco/html/index.html`
- Coverage report will be generated in `${project}/build/jacoco/html/index.html`
- Assemble: `./gradlew build`
- Install to local: `./gradlew install`
- Publish: `./gradlew publish --no-parallel`
Expand Down
35 changes: 17 additions & 18 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,29 @@
1. Make sure all build passes. You can check by `./gradlew clean build`.
2. Make a release branch by `git switch -c release/va.b.c`.
3. Make a prepare commit.
- Remove `-SNAPSHOT` postfix of `gradle.properties`.
- Update compatibility, example, ... of `README.md`. Boot starter compatibility can be checked in [here](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-dependencies/build.gradle).
- Remove `-SNAPSHOT` of `CHANGELOG.md`.
- Commit message: `Prepare for va.b.c`.
- Remove `-SNAPSHOT` postfix of `gradle.properties`.
- Update compatibility, example, ... of `README.md`. Boot starter compatibility can be checked in [here](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-dependencies/build.gradle).
- Update [CHANGELOG](./CHANGELOG.md).
- Commit message: `Prepare for va.b.c`.
4. Install to local by `./gradlew clean build install --no-build-cache`. Test it with example projects.
5. Make a tag `va.b.c`.
- Make a tag by `git tag va.b.c`.
- Push the tag by `git push origin va.b.c`.
- Make a tag by `git tag va.b.c`.
- Push the tag by `git push origin va.b.c`.
6. Wait for [deploy action](https://github.com/naver/spring-batch-plus/actions/workflows/deploy.yml) to be completed.
7. Check Staging Repositories in a [sonatype](https://oss.sonatype.org/).
- Click Close.
- Click Release.
- Click Close.
- Click Release.
8. Start a new version
- Update version of `gradle.properties` to `a.b.c-SHAPSHOT`.
- Add `## a.b.c-SHAPSHOT` to `CHANGELOG.md`.
- Commit message: `Start next iteration`.
- Update version of `gradle.properties` to `a.b.c-SHAPSHOT`.
- Commit message: `Start next iteration`.
9. Merge release branch.
- Merge release branch
- main : `git switch main && git merge release/va.b.c`.
- patch (a.b.x branch) : `git switch a.b.x && git merge release/va.b.c`.
- Delete release branch by `git branch -d release/va.b.c`.
- Push main to origin
- main : `git push origin main`.
- patch (a.b.x branch) : `git push origin a.b.x`.
- Merge release branch
- main : `git switch main && git merge release/va.b.c`.
- patch (a.b.x branch) : `git switch a.b.x && git merge release/va.b.c`.
- Delete release branch by `git branch -d release/va.b.c`.
- Push main to origin
- main : `git push origin main`.
- patch (a.b.x branch) : `git push origin a.b.x`.
10. Make a release on [github](https://github.com/naver/spring-batch-plus/releases) based on [CHANGELOG](./CHANGELOG.md).

## See also
Expand Down

0 comments on commit b89c08e

Please sign in to comment.