Skip to content

Commit cb5b56e

Browse files
lmajanolmajano
committed
### Added
* New changelog standards * Github release publishing of changelogs * New formatting scripts ### Fixed * ColdBox 6 compat on build links
1 parent 2c7b53e commit cb5b56e

9 files changed

+199
-116
lines changed

‎.cfformat.json

+60-52
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,62 @@
11
{
2-
"array.empty_padding" : false,
3-
"array.padding" : true,
4-
"array.multiline.min_length" : 40,
5-
"array.multiline.element_count" : 4,
6-
"array.multiline.leading_comma.padding" : true,
7-
"array.multiline.leading_comma" : false,
8-
"assignments.consecutive.alignment" : true,
9-
"brackets.padding" : true,
10-
"comment.asterisks" : "align",
11-
"binary_operators.padding" : true,
12-
"for_loop_semicolons.padding" : true,
13-
"function_call.empty_padding" : false,
14-
"function_call.padding" : true,
15-
"function_call.multiline.leading_comma.padding" : true,
16-
"function_call.casing.builtin" : "cfdocs",
17-
"function_call.casing.userdefined" : "",
18-
"function_call.multiline.element_count" : 4,
19-
"function_call.multiline.leading_comma" : false,
20-
"function_call.multiline.min_length" : 40,
21-
"function_declaration.padding" : true,
22-
"function_declaration.empty_padding" : false,
23-
"function_declaration.multiline.leading_comma" : false,
24-
"function_declaration.multiline.leading_comma.padding" : true,
25-
"function_declaration.multiline.element_count" : 4,
26-
"function_declaration.multiline.min_length" : 40,
27-
"function_declaration.group_to_block_spacing" : "compact",
28-
"function_anonymous.empty_padding" : false,
29-
"function_anonymous.group_to_block_spacing" : "compact",
30-
"function_anonymous.multiline.element_count" : 4,
31-
"function_anonymous.multiline.leading_comma" : false,
32-
"function_anonymous.multiline.leading_comma.padding" : true,
33-
"function_anonymous.multiline.min_length" : 40,
34-
"function_anonymous.padding" : false,
35-
"indent_size" : 4,
36-
"keywords.block_to_keyword_spacing" : "spaced",
37-
"keywords.group_to_block_spacing" : "spaced",
38-
"keywords.padding_inside_group" : true,
39-
"keywords.spacing_to_block" : "spaced",
40-
"keywords.spacing_to_group" : true,
41-
"keywords.empty_group_spacing" : false,
42-
"max_columns" : 120,
43-
"parentheses.padding" : true,
44-
"strings.quote" : "double",
45-
"strings.attributes.quote" : "double",
46-
"struct.separator" : " : ",
47-
"struct.padding" : true,
48-
"struct.empty_padding" : false,
49-
"struct.multiline.leading_comma" : false,
50-
"struct.multiline.leading_comma.padding" : true,
51-
"struct.multiline.element_count" : 4,
52-
"struct.multiline.min_length" : 40,
53-
"tab_indent" : true
2+
"array.empty_padding": false,
3+
"array.padding": true,
4+
"array.multiline.min_length": 40,
5+
"array.multiline.element_count": 2,
6+
"array.multiline.leading_comma.padding": true,
7+
"array.multiline.leading_comma": false,
8+
"alignment.consecutive.assignments": true,
9+
"alignment.consecutive.properties": true,
10+
"alignment.consecutive.params": true,
11+
"brackets.padding": true,
12+
"comment.asterisks": "align",
13+
"binary_operators.padding": true,
14+
"for_loop_semicolons.padding": true,
15+
"function_call.empty_padding": false,
16+
"function_call.padding": true,
17+
"function_call.multiline.leading_comma.padding": true,
18+
"function_call.casing.builtin": "cfdocs",
19+
"function_call.casing.userdefined": "camel",
20+
"function_call.multiline.element_count": 2,
21+
"function_call.multiline.leading_comma": false,
22+
"function_call.multiline.min_length": 40,
23+
"function_declaration.padding": true,
24+
"function_declaration.empty_padding": false,
25+
"function_declaration.multiline.leading_comma": false,
26+
"function_declaration.multiline.leading_comma.padding": true,
27+
"function_declaration.multiline.element_count": 2,
28+
"function_declaration.multiline.min_length": 40,
29+
"function_declaration.group_to_block_spacing": "compact",
30+
"function_anonymous.empty_padding": false,
31+
"function_anonymous.group_to_block_spacing": "compact",
32+
"function_anonymous.multiline.element_count": 2,
33+
"function_anonymous.multiline.leading_comma": false,
34+
"function_anonymous.multiline.leading_comma.padding": true,
35+
"function_anonymous.multiline.min_length": 40,
36+
"function_anonymous.padding": true,
37+
"indent_size": 4,
38+
"keywords.block_to_keyword_spacing": "spaced",
39+
"keywords.group_to_block_spacing": "spaced",
40+
"keywords.padding_inside_group": true,
41+
"keywords.spacing_to_block": "spaced",
42+
"keywords.spacing_to_group": true,
43+
"keywords.empty_group_spacing": false,
44+
"max_columns": 120,
45+
"metadata.multiline.element_count": 3,
46+
"metadata.multiline.min_length": 40,
47+
"method_call.chain.multiline": 3,
48+
"newline": "\n",
49+
"property.multiline.element_count": 3,
50+
"property.multiline.min_length": 40,
51+
"parentheses.padding": true,
52+
"strings.quote": "double",
53+
"strings.attributes.quote": "double",
54+
"struct.separator": " : ",
55+
"struct.padding": true,
56+
"struct.empty_padding": false,
57+
"struct.multiline.leading_comma": false,
58+
"struct.multiline.leading_comma.padding": true,
59+
"struct.multiline.element_count": 2,
60+
"struct.multiline.min_length": 40,
61+
"tab_indent": true
5462
}

‎.travis.yml

+20-3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ install:
4040
script:
4141
# Set Current Version
4242
- TARGET_VERSION=`cat $TRAVIS_BUILD_DIR/box.json | jq '.version' -r`
43+
- TRAVIS_TAG=${TARGET_VERSION}
4344
- echo "Starting build for ${MODULE_ID} v${TARGET_VERSION}"
4445
# Replace version so builder can issue it
4546
- box package set [email protected]@[email protected]@
@@ -49,16 +50,16 @@ script:
4950
- box install
5051
# run our matrix server
5152
- box server start serverConfigFile="server-${ENGINE}.json"
52-
# Startup the app
53+
# Startup the app: Uncomment if needed
5354
#- curl http://localhost:60299
5455
# Debugging of tests
5556
#- curl http://localhost:60299/tests/runner.cfm?reporter=json -o testresults.json && cat testresults.json
5657
# move back to build dir to build it
5758
- cd $TRAVIS_BUILD_DIR
5859
# Build Project
5960
- box task run taskfile=build/Build target=run :version=${TARGET_VERSION} :projectName=${MODULE_ID} :buildID=${TRAVIS_BUILD_NUMBER} :branch=${TRAVIS_BRANCH}
60-
# Cat results for debugging
61-
- cat build/results.json
61+
# Cat results for debugging: Uncomment if needed
62+
#- cat build/results.json
6263

6364
after_failure:
6465
- cd $TRAVIS_BUILD_DIR/test-harness
@@ -101,6 +102,22 @@ deploy:
101102
upload-dir: coldbox-modules/$MODULE_ID/$TARGET_VERSION
102103
acl: public_read
103104

105+
# Github Release only on Master
106+
- provider: releases
107+
api_key: ${GITHUB_TOKEN}
108+
on:
109+
branch:
110+
- master
111+
condition: "$ENGINE = lucee@5"
112+
skip_cleanup: true
113+
edge: true
114+
file_glob: true
115+
file: $TRAVIS_BUILD_DIR/.artifacts/$MODULE_ID/**/*
116+
release_notes_file: changelog-latest.md
117+
name: v${TRAVIS_TAG}
118+
tag_name: v${TRAVIS_TAG}
119+
overwrite: true
120+
104121
after_deploy:
105122
# Move to build out artifact
106123
- cd ${TRAVIS_BUILD_DIR}/.tmp/${MODULE_ID}

‎box.json

+6-3
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,15 @@
3535
"**/.*",
3636
"tests"
3737
],
38-
"scripts":{
39-
"toMaster":"recipe build/toMaster.boxr"
40-
},
4138
"installPaths":{
4239
"cbjavaloader":"modules/cbjavaloader/",
4340
"cbSwagger":"modules/cbSwagger/",
4441
"wikitext":"modules/wikitext/"
42+
},
43+
"scripts": {
44+
"release": "recipe build/release.boxr",
45+
"format": "cfformat run config/,handlers/,interceptors/,models/,test-harness/tests/specs",
46+
"format:watch": "cfformat watch config/,handlers/,interceptors/,models/,test-harness/tests/specs ./.cfformat.json",
47+
"format:check": "cfformat check config/,handlers/,interceptors/,models/,test-harness/tests/specs"
4548
}
4649
}

‎build/Build.cfc

+32-14
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ component{
1717

1818
// Source Excludes Not Added to final binary
1919
variables.excludes = [
20-
".vscode",
21-
".editorconfig",
20+
".vscode",
21+
".editorconfig",
2222
".gitignore",
2323
".travis.yml",
2424
".artifacts",
2525
".tmp",
2626
".DS_Store",
2727
".git",
2828
".gitattributes",
29-
"build",
30-
"modules",
29+
"build",
30+
"modules",
3131
"node_modules",
3232
"resources",
3333
"test-harness",
@@ -39,7 +39,6 @@ component{
3939
"webpack.config.js",
4040
".cfformat.json",
4141
".cflintrc"
42-
4342
];
4443

4544
// Cleanup + Init Build Directories
@@ -85,15 +84,18 @@ component{
8584
docs( argumentCollection=arguments );
8685

8786
// checksums
88-
buildChecksums();
87+
buildChecksums();
88+
89+
// Build latest changelog
90+
latestChangelog();
8991

9092
// Finalize Message
9193
print.line()
9294
.boldMagentaLine( "Build Process is done! Enjoy your build!" )
9395
.toConsole();
9496
}
9597

96-
/**
98+
/**
9799
* Run the test suites
98100
*/
99101
function runTests(){
@@ -187,12 +189,7 @@ component{
187189
*/
188190
function docs( required projectName, version="1.0.0", outputDir=".tmp/apidocs" ){
189191
// Generate Docs
190-
print.greenLine( "Generating API Docs, please wait..." ).toConsole();
191-
192-
if( directoryExists( arguments.outputDir ) ){
193-
directoryDelete( arguments.outputDir, true );
194-
}
195-
192+
print.greenLine( "Generating API Docs, please wait..." ).toConsole();
196193
directoryCreate( arguments.outputDir, true, true );
197194

198195
command( 'docbox generate' )
@@ -215,7 +212,28 @@ component{
215212
overwrite=true,
216213
recurse=true
217214
);
218-
}
215+
}
216+
217+
/**
218+
* Build the latest changelog file: changelog-latest.md
219+
*/
220+
function latestChangelog(){
221+
print.blueLine( "Building latest changelog..." ).toConsole();
222+
223+
if( !fileExists( variables.cwd & "changelog.md" ) ){
224+
return error( "Cannot continue building, changelog.md file doesn't exist!" );
225+
}
226+
227+
fileWrite(
228+
variables.cwd & "changelog-latest.md",
229+
fileRead( variables.cwd & 'changelog.md' ).split( '----' )[2].trim() & chr( 13 ) & chr( 10 )
230+
);
231+
232+
print
233+
.greenLine( "Latest changelog file created at `changelog-latest.md`" )
234+
.line()
235+
.line( fileRead( variables.cwd & "changelog-latest.md" ) );
236+
}
219237

220238
/********************************************* PRIVATE HELPERS *********************************************/
221239

‎build/toMaster.boxr ‎build/release.boxr

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
# This recipe signifies a new release of the module by doing merges and bumps accordingly
22

3-
# Check out master
3+
# Check out master and update it locally
44
!git checkout -f master
5-
# Merge development into it
5+
!git pull origin master
6+
7+
# Merge development into it for release
68
!git merge --no-ff development
7-
# Tag the master repo with the version in box.json
9+
10+
# Tag the master repo with the version from box.json
811
!git tag v`box package show version`
9-
# Push all branches
12+
13+
# Push all branches back out to github
1014
!git push origin --all
15+
1116
# Push all tags
1217
!git push origin --tags
18+
1319
# Check development again
1420
!git checkout -f development
21+
1522
# Bump to prepare for a new release, do minor, change if needed and don't tag
1623
bump --minor --!tagVersion
17-
# Send it out
1824
!git commit -a -m "version bump"
1925
!git push origin development

0 commit comments

Comments
 (0)