-
Notifications
You must be signed in to change notification settings - Fork 42
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.
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
Admin: adopting auto-changelog #1171
Conversation
I'm onboard with adding auto-changelog as a dependency. I also like the simplicity of being able to run |
While looking for something else, I just realized github has an option to automatically create release notes. This would simplify our release process even more than auto-changelog and is configurable. I'd welcome thoughts on this as an option. |
@zhen0 I looked into github generated release notes, it looks like a great option! (example below) The only caveat I see is that we would no longer have a physical file in our repository, release notes would only be available on github. I personally think this is fine but we should validate that nobody objects to deleting of changelog.md from our repository. What's Changed
New Contributors
Full Changelog: 2021-12-15...2021-12-21 |
Good question @stackoverfloweth - I've shared this question in slack to see if we can gain consensus. For this repo I'm not convinced about the benefit of completely replacing the changelog since the entries in there took time and effort to represent the work that had been done. Cutting a changelog also gives me a chance to check the QA checklist has been completed. |
So my vote would be to add the npm script but not completely overwrite the existing changelog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to approve this if we remove the changelog override.
Further thought and discussion on this - let's do it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stackoverfloweth - I'm happy to give this a trial. We can always revert if we find we want that more detailed log. The more thought through changelog descriptions will be maintained in the release notes and the changelog.md file contains PR links that let us see what was released when. Your change here also makes it easier to run auto-changelog to see what is still unreleased.
I think you'll need to fix the merge conflict on changelog.md though.
I added auto-changelog as a dev-depenedency and an npm script so that any developer could generate the changelog without having to know to install auto-changelog manually to their machine. If we merge as presented, we would no longer maintain and append to an existing changelog. Running
npm run changelog
generates the entire changelog.md file in the "new format" of Tag (2021-12-14) followed by a list of all PRs merged between tags. Each tag and each pr includes links to github for additional context. This approach still requires that we get into the habit of proper naming for PR titles (hotfix, feature, etc).Take a look how this PR changes changelog.md. It's rewritting historical changelog entries to fit the new format, and since those old PRs were not created with expectation of the title being used in the changelog they are not always extremely descriptive. I do not personally believe that this is a reason to maintain, and only append to the changelog, as most users are probably only looking at what changed in more recent history.
We can still benefit from some of the changes in this PR even if we decide against re-writting the existing portion of our changelog. I wanted to use this PR as a place to discuss, as it has the changes attached.
Here is how the changelog is rendered:
Changelog
2021-12-14a
#1165
#1162
#1163
#1158
2021-12-14
#1156
#1139
#1125
#1055
#1151
#1054
#1052
#1150
#1134
#1148
#1120
#1143
#1144
#1129
#1145
#1127
#1137
#1136
#1103
#1104
#1101
#1135
#1132
#1102
#1123
#1131
#1121
#1128
#1124
#1119
#1098
#1095
#1126
#1089
2021-11-09
#1122
#1117
#1041
#1099
#1109
#1107
#1108
#1096
2021-11-01
#1106
#1105
#1100
#1094
#1091
#1037
#1053
#1078
#1087
#1079
#1083
#1081
#1073
#1076
2021-10-06
#1074
2021-10-05
#1064
#1065
#1062
#1058
2021-09-20
#1038
#1047
#1042
#1044
2021-09-07
#1039
#1033
#1032
#1036
#1029
#1027
#1026
#1025
#1030
#1024
#1020
#1019
#1011
#1013
2021-08-18
#1007
#1006
#1003
2021-08-17
#1002
#1001
#988
#991
#989
#987
#986
#955
2021-08-05
#985
#984
#982
#981
#980
2021-08-02
#974
2021-07-29
#970
#966
#941
#964
2021-07-22
#961
#960
2021-07-21
#959
#957
#958
#946
#947
2021-07-13
#943
#939
#940
#938
#936
#937
#922
#925
#932
#919
#923
#921
2021-06-24
#920
#918
2021-06-23a
#917
#916
2021-06-23
#915
#914
#909
#910
#913
#908
#912
#881
#902
#901
2021-06-17
#900
#898
#897
#896
#852
#895
#863
#891
#890
#887
2021-06-02
#880
#879
#804
2021-06-01
#875
#862
#818
2021-05-25
#859
#858
2021-05-24
#857
#846
#849
#847
#848
#850
#844
#839
#835
#825
#811
2021-05-17
#842
#841
#837
2021-05-14
#833
#828
#808
#815
#824
#763
#814
#816
#820
2021-05-05
#812
#810
#787
2021-05-04
#809
#806
#769
#802
#784
#782
2021-04-23
#791
2021-04-22
#788
#789
2021-04-21
#785
#783
#774
2021-04-15
#779
#773
#770
#778
#777
#759
#772
#771
#768
#767
#766
2021-04-09a
#760
#751
2021-04-09
#756
#754
#753
#736
2021-04-07
#750
#747
#748
#714
#737
2021-04-06a
#744
#743
2021-04-06
#742
#741
#740
2021-04-05
#739
#738
#708
#725
#722
#719
#720
#721
#692
#716
#712
#711
#710
#706
#707
#695
#678
#699
#693
#696
#674
2021-03-25
#694
#683
#690
#689
#688
#691
#679
#662
#677
#675
2021-03-16
#676
#672
#673
#665
2021-03-15a
#671
#670
2021-03-15
#668
#656
#657
#652
#645
#653
#650
2021-03-09
#651
#646
#640
#633
2021-03-02
#638
#631
#628
#617
2021-02-23
#627
#616
#621
#615
#590
#591
2021-02-12
#611
#610
2021-02-11
#607
#606
#605
#601
#585
#563
#598
#597
#595
#593
#592
2021-02-03
#589
#587
#583
#577
2021-01-28
#580
#576
#570
#574
#556
2021-01-25
#559
#532
#562
#561
2021-01-19
#560
#558
#553
#538
2021-01-07
#537
#533
#534
#516
#529
2021-01-05
#531
#530
#524
#520
#526
#527
#518
#509
#433
2020-12-18
#517
#515
#512
#511
#507
2020-12-14
#506
#495
#498
#485
2020-12-07
#493
#491
#484
#488
#482
#465
#480
#451
#476
#475
2020-11-30
#474
#470
#471
#468
#441
#434
#452
#431
#449
#448
#440
2020-11-13
#436
#435
2020-11-12
#432
#278
#428
2020-11-11
#429
#403
#390
#425
#411
#417
2020-11-10
#416
#410
#401
#400
#402
#372
#395
#398
#396
#399
2020-10-29a
#391
#389
#377
#382
#370
2020-10-29
#388
#387
#368
#373
2020-10-23
#375
#364
#367
#359
#363
#365
2020-10-21
#362
#355
#360
#354
#344
#330
2020-10-13
#326
#323
#321
#313
#317
flow.run_config
in label warning#312
#303
flow.run_config
if present#309
2020-10-09
#310
#308
Run Config
section to flow details#307
#305
#306
#304
#300
#299
#302
#295
#285
#266
#298
#294
2020-10-05
#291
#249
#277
#269
2020-10-01
#279
#275
#274
#273
#270
#271
2020-09-29
#268
#267
#248
#264
2020-09-28a
#262
#255
#260
#245
2020-09-28
#259
#258
2020-09-24
#254
#253
#247
2020-09-23
#246
#241
#236
#238
#217
#237
2020-09-17
#235
#232
#233
#231
#195
#227
2020-09-15
#228
#219
#216
#220
#218
#212
2020-09-08
#209
#201
#200
#199
#188
#162
#193
#192
#190
2020-09-01
#189
#187
#186
#127
#183
#185
#164
#176
2020-08-31a
#181
#180
#179
2020-08-31
#178
#177
#174
2020-08-28
#171
#170
#169
#165
#163
#166
2020-08-27
#161
#159
#158
2020-08-26
#156
#155
2020-08-25
#143
#142
#140
2020-08-24
#138
#137
2020-08-22
#128
#124
2020-08-20
#125
#123
2020-08-19
#122
2020-08-18
#121
#120
#119
#118
#117
#106
#116
#108
#105
#104
#103
#98
#96
#95
#92
#89
#86
#84
#83
#82
#81
#77
#76
#75
#72
#73
#74
#71
#51
#70
#69
#68
#67
#66
#65
#64
#59
#62
#61
#60
#58
#46
#42
#57
#55
#56
#54
#48
#53
#44
#45
#50
#49
#43
#41
#30
#39
#29
#28
#27
#20
#23
#24
#21
#25
#13
#16
#17
#18
#8
#6
#7
#5
#4
#3
#2
#1