Skip to content

Commit b89c08e

Browse files
authored
Polish markdown files
Signed-off-by: Taeik Lim <[email protected]>
1 parent 0b7cfc5 commit b89c08e

File tree

4 files changed

+29
-59
lines changed

4 files changed

+29
-59
lines changed

.editorconfig

+4-4
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ trim_trailing_whitespace = true
4646
# [indentation-tab]
4747
indent_style = space
4848

49-
# [2-spaces-tab]
50-
indent_size = 2
51-
tab_width = 2
49+
# [4-spaces-tab]
50+
indent_size = 4
51+
tab_width = 4
5252

5353
# [no-trailing-spaces]
54-
trim_trailing_whitespace = true
54+
trim_trailing_whitespace = true

CHANGELOG.md

+1-30
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# ChangeLog
22

33
- [1.1.x](#11x)
4-
- [1.1.0-SNAPSHOT](#110-snapshot)
4+
- [1.1.0](#110)
55
- [1.0.x](#10x)
6-
- [1.0.2-SNAPSHOT](#102-snapshot)
76
- [1.0.1](#101)
87
- [1.0.0](#100)
98
- [0.3.x](#03x)
@@ -16,20 +15,6 @@
1615

1716
## 1.1.x
1817

19-
### 1.1.1-SNAPSHOT
20-
21-
#### New Features
22-
23-
- None
24-
25-
#### Changes
26-
27-
- None
28-
29-
#### Bug fixes & Improvements
30-
31-
- None
32-
3318
### 1.1.0
3419

3520
#### New Features
@@ -51,20 +36,6 @@
5136

5237
## 1.0.x
5338

54-
### 1.0.2-SNAPSHOT
55-
56-
#### New Features
57-
58-
- None
59-
60-
#### Changes
61-
62-
- None
63-
64-
#### Bug fixes & Improvements
65-
66-
- None
67-
6839
### 1.0.1
6940

7041
#### New Features

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,14 @@ Java
169169
## User Guide
170170

171171
- 1.1.x
172-
- [Korean](https://github.com/naver/spring-batch-plus/tree/main/doc/ko)
173-
- [English](https://github.com/naver/spring-batch-plus/tree/main/doc/en)
172+
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.1.x/doc/ko)
173+
- [English](https://github.com/naver/spring-batch-plus/tree/1.1.x/doc/en)
174174
- 1.0.x
175-
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/ko)
176-
- [English](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/en)
175+
- [Korean](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/ko)
176+
- [English](https://github.com/naver/spring-batch-plus/tree/1.0.x/doc/en)
177177
- 0.3.x
178-
- [Korean](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/ko)
179-
- [English](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/en)
178+
- [Korean](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/ko)
179+
- [English](https://github.com/naver/spring-batch-plus/tree/0.3.x/doc/en)
180180

181181
## Build from source
182182

@@ -189,7 +189,7 @@ Java
189189

190190
- Clean: `./gradlew clean`
191191
- Check: `./gradlew check`
192-
- Coverage report will be generated in `${project}/build/jacoco/html/index.html`
192+
- Coverage report will be generated in `${project}/build/jacoco/html/index.html`
193193
- Assemble: `./gradlew build`
194194
- Install to local: `./gradlew install`
195195
- Publish: `./gradlew publish --no-parallel`

RELEASE_PROCESS.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,29 @@
33
1. Make sure all build passes. You can check by `./gradlew clean build`.
44
2. Make a release branch by `git switch -c release/va.b.c`.
55
3. Make a prepare commit.
6-
- Remove `-SNAPSHOT` postfix of `gradle.properties`.
7-
- 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).
8-
- Remove `-SNAPSHOT` of `CHANGELOG.md`.
9-
- Commit message: `Prepare for va.b.c`.
6+
- Remove `-SNAPSHOT` postfix of `gradle.properties`.
7+
- 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).
8+
- Update [CHANGELOG](./CHANGELOG.md).
9+
- Commit message: `Prepare for va.b.c`.
1010
4. Install to local by `./gradlew clean build install --no-build-cache`. Test it with example projects.
1111
5. Make a tag `va.b.c`.
12-
- Make a tag by `git tag va.b.c`.
13-
- Push the tag by `git push origin va.b.c`.
12+
- Make a tag by `git tag va.b.c`.
13+
- Push the tag by `git push origin va.b.c`.
1414
6. Wait for [deploy action](https://github.com/naver/spring-batch-plus/actions/workflows/deploy.yml) to be completed.
1515
7. Check Staging Repositories in a [sonatype](https://oss.sonatype.org/).
16-
- Click Close.
17-
- Click Release.
16+
- Click Close.
17+
- Click Release.
1818
8. Start a new version
19-
- Update version of `gradle.properties` to `a.b.c-SHAPSHOT`.
20-
- Add `## a.b.c-SHAPSHOT` to `CHANGELOG.md`.
21-
- Commit message: `Start next iteration`.
19+
- Update version of `gradle.properties` to `a.b.c-SHAPSHOT`.
20+
- Commit message: `Start next iteration`.
2221
9. Merge release branch.
23-
- Merge release branch
24-
- main : `git switch main && git merge release/va.b.c`.
25-
- patch (a.b.x branch) : `git switch a.b.x && git merge release/va.b.c`.
26-
- Delete release branch by `git branch -d release/va.b.c`.
27-
- Push main to origin
28-
- main : `git push origin main`.
29-
- patch (a.b.x branch) : `git push origin a.b.x`.
22+
- Merge release branch
23+
- main : `git switch main && git merge release/va.b.c`.
24+
- patch (a.b.x branch) : `git switch a.b.x && git merge release/va.b.c`.
25+
- Delete release branch by `git branch -d release/va.b.c`.
26+
- Push main to origin
27+
- main : `git push origin main`.
28+
- patch (a.b.x branch) : `git push origin a.b.x`.
3029
10. Make a release on [github](https://github.com/naver/spring-batch-plus/releases) based on [CHANGELOG](./CHANGELOG.md).
3130

3231
## See also

0 commit comments

Comments
 (0)