Skip to content

Commit f0cfda7

Browse files
authored
[release-15.0] Re-organize the releasenotes directory into changelog (vitessio#12566) (vitessio#12659)
* Re-organize the `releasenotes` directory into `changelog` (vitessio#12566) * Move all release related documents to ./release and add tool to generate READMEs Signed-off-by: Florent Poinsard <[email protected]> * Addition of the release.go file Signed-off-by: Florent Poinsard <[email protected]> * simplify release.go Signed-off-by: Florent Poinsard <[email protected]> * generate the release notes in the proper place Signed-off-by: Florent Poinsard <[email protected]> * modify previous mentions of docs/releasenotes Signed-off-by: Florent Poinsard <[email protected]> * re-add v17.0.0 summary Signed-off-by: Florent Poinsard <[email protected]> * add new release tool to release instruction and ci Signed-off-by: Florent Poinsard <[email protected]> * apply review suggestions Signed-off-by: Florent Poinsard <[email protected]> * simplify release notes document path Signed-off-by: Florent Poinsard <[email protected]> * Apply review suggestions and fix team files Signed-off-by: Florent Poinsard <[email protected]> --------- Signed-off-by: Florent Poinsard <[email protected]> * update the changelog dir and release_notes_label workflow Signed-off-by: Florent Poinsard <[email protected]> --------- Signed-off-by: Florent Poinsard <[email protected]>
1 parent f568a5c commit f0cfda7

File tree

87 files changed

+461
-64
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+461
-64
lines changed

.github/workflows/release_notes_label.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- name: Release Notes label
1818
run: |
1919
if [[ "${{contains( github.event.pull_request.labels.*.name, 'release notes (needs details)')}}" == "true" ]]; then
20-
echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./doc/releasenotes/16_0_0_summary.md')". Once documented, the "release notes (needs details)" label can be removed.
20+
echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./changelog/15.0/15.0.3/summary.md')". Once documented, the "release notes (needs details)" label can be removed.
2121
exit 1
2222
fi
2323

.github/workflows/static_checks_etc.yml

+17
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ jobs:
9090
ci_config:
9191
- 'test/config.json'
9292
- '.github/workflows/static_checks_etc.yml'
93+
release_notes:
94+
- 'changelog/**'
95+
- './go/tools/releases/**'
9396
9497
- name: Set up Go
9598
if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.proto_changes == 'true')
@@ -199,3 +202,17 @@ jobs:
199202
if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.ci_config == 'true')
200203
run: |
201204
go run ./go/tools/ci-config/main.go || exit 1
205+
206+
- name: Check changelog
207+
if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.release_notes == 'true'
208+
run: |
209+
set -e
210+
go run ./go/tools/releases/releases.go
211+
output=$(git status -s)
212+
if [ -z "${output}" ]; then
213+
exit 0
214+
fi
215+
echo 'We wish to maintain a consistent changelog directory, please run `go run ./go/tools/releases/releases.go`, commit and push again.'
216+
echo 'Running `go run ./go/tools/releases/releases.go` on CI yields the following changes:'
217+
echo "$output"
218+
echo ""

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ _test/
7070
/vendor/*/
7171

7272
# release folder
73-
releases
73+
/releases/
7474

7575
# Angular2 Bower Libs
7676
/web/vtctld2/.bowerrc~

changelog/10.0/README.md

+18

changelog/11.0/README.md

+15

doc/releasenotes/12_0_5_release_notes.md changelog/12.0/12.0.5/release_notes.md

+1-1

doc/releasenotes/12_0_6_release_notes.md changelog/12.0/12.0.6/release_notes.md

+1-1

changelog/12.0/README.md

+23

doc/releasenotes/13_0_2_release_notes.md changelog/13.0/13.0.2/release_notes.md

+1-1

doc/releasenotes/13_0_3_release_notes.md changelog/13.0/13.0.3/release_notes.md

+1-1

changelog/13.0/README.md

+14

doc/releasenotes/14_0_0_release_notes.md changelog/14.0/14.0.0/release_notes.md

+1-1

doc/releasenotes/14_0_1_release_notes.md changelog/14.0/14.0.1/release_notes.md

+1-1

doc/releasenotes/14_0_2_release_notes.md changelog/14.0/14.0.2/release_notes.md

+1-1

doc/releasenotes/14_0_3_release_notes.md changelog/14.0/14.0.3/release_notes.md

+1-1

changelog/14.0/README.md

+16

doc/releasenotes/15_0_0_release_notes.md changelog/15.0/15.0.0/release_notes.md

+1-1

doc/releasenotes/15_0_1_release_notes.md changelog/15.0/15.0.1/release_notes.md

+1-1

doc/releasenotes/15_0_2_release_notes.md changelog/15.0/15.0.2/release_notes.md

+1-1

changelog/15.0/README.md

+13

changelog/15.0/team.md

+5

changelog/7.0/README.md

+12

changelog/8.0/README.md

+3

changelog/9.0/README.md

+9

changelog/README.md

+10

0 commit comments

Comments
 (0)