Skip to content

Commit

Permalink
CHANGES script update (#548)
Browse files Browse the repository at this point in the history 
- Temp CALL/OUTPUT workaround removed
- Fixed path typo in template-CHANGES.md
- Provided some examples of notable changes in README.md
- Small tidy-up/grouping of changes (in cherry-pick-map)
  • Loading branch information
@draegtun
draegtun committed Jun 14, 2017
1 parent 0e5233c commit 7a1e396
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 35 deletions.
24 changes: 9 additions & 15 deletions CHANGES.md
View file
Expand Up @@ -2,7 +2,7 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and is auto-generated using `./scripts/build-CHANGES/build-CHANGES.reb`
The format is based on [Keep a Changelog](http://keepachangelog.com/) and is auto-generated using `./scripts/changes-file/make-changes-file.reb`

Alternate ChangeLogs:

Expand All @@ -20,6 +20,7 @@ Alternatively using Git:
- ``` Add just DETAB-FILE from pull request, with note, no line deletions ``` *@hostilefork* | [25a40c6](https://github.com/metaeducation/ren-c/commit/25a40c6)
- ``` Add an encapper for Windows PE ``` *@zsx* | [8ef2488](https://github.com/metaeducation/ren-c/commit/8ef2488)
- ``` Added CONSOLE! object & skinning ``` *@draegtun* | [922658f](https://github.com/metaeducation/ren-c/commit/922658f) [922658f](https://github.com/metaeducation/ren-c/commit/922658f) [922658f](https://github.com/metaeducation/ren-c/commit/922658f) [wiki](https://github.com/r3n/reboldocs/wiki/User-and-Console)
- ``` Introduce source checking of Rebol files. ``` *@codebybrett* | [46cf8e7](https://github.com/metaeducation/ren-c/commit/46cf8e7)
- ``` voiding SELECT*, PICK*, TAKE* w/convenience wraps SELECT, PICK, TAKE ``` *@hostilefork* | [33b8f02](https://github.com/metaeducation/ren-c/commit/33b8f02) [33b8f02](https://github.com/metaeducation/ren-c/commit/33b8f02) [33b8f02](https://github.com/metaeducation/ren-c/commit/33b8f02) [33b8f02](https://github.com/metaeducation/ren-c/commit/33b8f02) [trello](https://trello.com/c/pWMjGYl7/)
- ``` Customizable userspace ECHO based on HIJACK ``` *@hostilefork* | [de46d25](https://github.com/metaeducation/ren-c/commit/de46d25)
- ``` Add a WITH_FFI option to makefile ``` *@zsx* | [177dfdc](https://github.com/metaeducation/ren-c/commit/177dfdc)
Expand Down Expand Up @@ -138,6 +139,7 @@ foo takes 3 and then 7
- ``` Add CHECK-SET routine per suggestion from @earl ``` *@hostilefork* | [3c665c3](https://github.com/metaeducation/ren-c/commit/3c665c3)
- ``` Add COLLECT-WITH mezzanine to specify "keeper" ``` *@hostilefork* | [93d2677](https://github.com/metaeducation/ren-c/commit/93d2677) [trello](https://trello.com/c/FWFFMz68/)
- ``` FOR-SKIP synonym for FORSKIP and FOR-NEXT / FOR-BACK for FORALL ``` *@hostilefork* | [e8419e6](https://github.com/metaeducation/ren-c/commit/e8419e6) [trello](https://trello.com/c/StCADPIB/)
- ``` Breakpoints + Interactive Debugging ``` *@hostilefork* | [6711dc2](https://github.com/metaeducation/ren-c/commit/6711dc2)
- ``` Added SOMETHING? & NOTHING? ``` *@hostilefork* | [fab1090](https://github.com/metaeducation/ren-c/commit/fab1090) [fab1090](https://github.com/metaeducation/ren-c/commit/fab1090) [trello](https://trello.com/c/QBZGM8GY/)
- ``` Add SET? native, remove x: () disablement from legacy ``` *@hostilefork* | [e8e30e9](https://github.com/metaeducation/ren-c/commit/e8e30e9)
- ``` Add <local> tag to FUNC + CLOS, move <infix> ``` *@hostilefork* | [c77b6b4](https://github.com/metaeducation/ren-c/commit/c77b6b4) [trello](https://trello.com/c/WKGaad6F/)
Expand Down Expand Up @@ -198,17 +200,13 @@ foo: function [s] [
- ``` Make APPEND on port act as WRITE/APPEND in slightly less hacky way ``` *@hostilefork* | [62d137e](https://github.com/metaeducation/ren-c/commit/62d137e)
- ``` LENGTH-OF, HEAD-OF, TAIL-OF as core names...aliased to shorter ``` *@hostilefork* | [29ae001](https://github.com/metaeducation/ren-c/commit/29ae001) [trello](https://trello.com/c/4OT7qvdu/)
- ``` Check for end of file newline for all text formats. (#471) ``` *@codebybrett* | [523a890](https://github.com/metaeducation/ren-c/commit/523a890)
- ``` Introduce source checking of Rebol files. ``` *@codebybrett* | [46cf8e7](https://github.com/metaeducation/ren-c/commit/46cf8e7)
- ``` Bring back DUMP changes, move DUMP out of base ``` *@hostilefork* | [080b9c6](https://github.com/metaeducation/ren-c/commit/080b9c6)
- ``` Allow hard-quoting of BAR!, yet still disallow QUOTE | ``` *@hostilefork* | [b24f1ce](https://github.com/metaeducation/ren-c/commit/b24f1ce)
- ``` Disallow PICK on MAP! ``` *@hostilefork* | [9232b3b](https://github.com/metaeducation/ren-c/commit/9232b3b)
- ``` HELP patches to permit FOR-EACH [key val] lib [help :key] ``` *@hostilefork* | [92cbbcf](https://github.com/metaeducation/ren-c/commit/92cbbcf)
- ``` Simplifying rewrite of REWORD, TO and THRU of BLANK! are no-ops ``` *@hostilefork* | [ef25751](https://github.com/metaeducation/ren-c/commit/ef25751)
- ``` Check for END when using a DO rule in PARSE ``` *@hostilefork* | [1e9621e](https://github.com/metaeducation/ren-c/commit/1e9621e)
- ``` Turn BMP code into an extension ``` *@zsx* | [4a89744](https://github.com/metaeducation/ren-c/commit/4a89744)
- ``` Turn JPG codec into an extension ``` *@zsx* | [97ca06b](https://github.com/metaeducation/ren-c/commit/97ca06b)
- ``` Turn GIF codec into an extension ``` *@zsx* | [4638e58](https://github.com/metaeducation/ren-c/commit/4638e58)
- ``` Make png codec an extension ``` *@zsx* | [36d9a74](https://github.com/metaeducation/ren-c/commit/36d9a74)
- ``` Turn BMP, JPG, GIF & PNG codec into an extension ``` *@zsx* | [4a89744](https://github.com/metaeducation/ren-c/commit/4a89744) [4a89744](https://github.com/metaeducation/ren-c/commit/4a89744) [4a89744](https://github.com/metaeducation/ren-c/commit/4a89744) [4a89744](https://github.com/metaeducation/ren-c/commit/4a89744)
- ``` Support extensions as dynamically linked libraries ``` *@zsx* | [ef9975e](https://github.com/metaeducation/ren-c/commit/ef9975e)
- ``` Test @GrahamChiu's s3 upload for travis.yml ``` *@hostilefork* | [4ab24cd](https://github.com/metaeducation/ren-c/commit/4ab24cd)
- ``` Put REPL and host startup code into lib, not user ``` *@hostilefork* | [489ca6a](https://github.com/metaeducation/ren-c/commit/489ca6a)
Expand Down Expand Up @@ -277,7 +275,6 @@ foo: function [s] [
- ``` Mold fixes for MAP! ``` *@hostilefork* | [133200b](https://github.com/metaeducation/ren-c/commit/133200b)
- ``` Move variadic DO to r3-legacy, allow 0-arity DO ``` *@hostilefork* | [3aa675b](https://github.com/metaeducation/ren-c/commit/3aa675b)
- ``` Move TITLE-OF to user mode code ``` *@hostilefork* | [c6171b3](https://github.com/metaeducation/ren-c/commit/c6171b3)
- ``` Get rid of RM as unix `remove` ``` *@hostilefork* | [2a7fcbb](https://github.com/metaeducation/ren-c/commit/2a7fcbb)
- ``` Implement SPEC-OF and BODY-OF for specializations ``` *@hostilefork* | [08dd85d](https://github.com/metaeducation/ren-c/commit/08dd85d)
- ``` OneFunction: Unify functions under FUNCTION! ``` *@hostilefork* | [c61daa4](https://github.com/metaeducation/ren-c/commit/c61daa4)
- ``` CASE special handling of expression barriers ``` *@hostilefork* | [dd18504](https://github.com/metaeducation/ren-c/commit/dd18504)
Expand Down Expand Up @@ -308,7 +305,6 @@ foo: function [s] [
- ``` Adjust DECODE-URL to give back NONE hosts ``` *@hostilefork* | [4658148](https://github.com/metaeducation/ren-c/commit/4658148)
- ``` Convert canon NONE, UNSET, etc. to globals ``` *@hostilefork* | [62d2a5a](https://github.com/metaeducation/ren-c/commit/62d2a5a)
- ``` Use NOOP so empty loop looks more intentional ``` *@hostilefork* | [c43dd18](https://github.com/metaeducation/ren-c/commit/c43dd18)
- ``` Breakpoints + Interactive Debugging ``` *@hostilefork* | [6711dc2](https://github.com/metaeducation/ren-c/commit/6711dc2)
- ``` EXIT/FROM any stack level, natives ``` *@hostilefork* | [5e9ec3e](https://github.com/metaeducation/ren-c/commit/5e9ec3e) [trello](https://trello.com/c/noiletwM/)
- ``` Programmatic GDB breakpoint support ``` *@hostilefork* | [2294dce](https://github.com/metaeducation/ren-c/commit/2294dce)
- ``` Tidy new-line implementation, no bitwise XOR ``` *@hostilefork* | [9cad6b8](https://github.com/metaeducation/ren-c/commit/9cad6b8)
Expand All @@ -326,7 +322,6 @@ foo: function [s] [
- ``` Default IF, WHILE, EVERY to unsets, x: () legal ``` *@hostilefork* | [778da31](https://github.com/metaeducation/ren-c/commit/778da31)
- ``` Dividing money amounts returns decimal ``` *@hostilefork* | [a3f249c](https://github.com/metaeducation/ren-c/commit/a3f249c)
- ``` TO-INTEGER/UNSIGNED and conversion fixes ``` *@hostilefork* | [e9c4fcf](https://github.com/metaeducation/ren-c/commit/e9c4fcf) [trello](https://trello.com/c/I6Y3NWlR/)
- ``` Get rid of UTYPE! stub, datatype=>symbol fix ``` *@hostilefork* | [a25c359](https://github.com/metaeducation/ren-c/commit/a25c359)
- ``` Move FUNCT to be in <r3-legacy> mode only ``` *@hostilefork* | [bb51e94](https://github.com/metaeducation/ren-c/commit/bb51e94)
- ``` SWITCH uses EQUAL?+STRICT-EQUAL?, more... ``` *@hostilefork* | [46c1d1f](https://github.com/metaeducation/ren-c/commit/46c1d1f)
- ``` Move /WORD off of TYPE-OF and onto TYPE? ``` *@hostilefork* | [f1f516d](https://github.com/metaeducation/ren-c/commit/f1f516d)
Expand All @@ -347,7 +342,6 @@ foo: function [s] [
- ``` Enbase fixes for input zero length strings ``` *@hostilefork* | [85013fe](https://github.com/metaeducation/ren-c/commit/85013fe)
- ``` Error handling overhaul, includes CC#1743 ``` *@hostilefork* | [9b21568](https://github.com/metaeducation/ren-c/commit/9b21568) [#CC-1743](https://github.com/rebol/rebol-issues/issues/1743)
- ``` Revert "Remove /NOW refinement from QUIT (CC#1743)" ``` *@hostilefork* | [37c723e](https://github.com/metaeducation/ren-c/commit/37c723e) [#CC-1743](https://github.com/rebol/rebol-issues/issues/1743)
- ``` Get rid of Lit-Word decay (CC#2101, CC#1434) ``` *@hostilefork* | [f027870](https://github.com/metaeducation/ren-c/commit/f027870) [#CC-2101](https://github.com/rebol/rebol-issues/issues/2101) [#CC-1434](https://github.com/rebol/rebol-issues/issues/1434) [trello](https://trello.com/c/MVLLDYJW/)
- ``` Interim workaround for CC#2221 ``` *@hostilefork* | [5267b00](https://github.com/metaeducation/ren-c/commit/5267b00) [#CC-2221](https://github.com/rebol/rebol-issues/issues/2221)
- ``` Switch version number to 2.102.0, for the time being ``` *@earl* | [89a75c7](https://github.com/metaeducation/ren-c/commit/89a75c7)
- ``` Accept file! to CALL ``` *@zsx* | [bc6c9b6](https://github.com/metaeducation/ren-c/commit/bc6c9b6)
Expand All @@ -366,15 +360,11 @@ foo: function [s] [
- ``` Make FUNCTION a FUNCT alias (#1773) ``` *@BrianHawley* | [3e6ecf7](https://github.com/metaeducation/ren-c/commit/3e6ecf7)
- ``` cc-1748: Guard protected blocks from /INTO target of REDUCE, COMPOSE ``` *@hostilefork* | [21fb3c2](https://github.com/metaeducation/ren-c/commit/21fb3c2) [#CC-1748](https://github.com/rebol/rebol-issues/issues/1748)
- ``` Free intermediate buffers used by do-codec (CC #2068) ``` *@hostilefork* | [e1d8d05](https://github.com/metaeducation/ren-c/commit/e1d8d05) [#CC-2068](https://github.com/rebol/rebol-issues/issues/2068)
- ``` Get rid of LOAD /next ``` *@BrianHawley* | [8da64f8](https://github.com/metaeducation/ren-c/commit/8da64f8)
- ``` Copied DELETE-DIR from Rebol 2 (cc#1545) ``` *Tamas Herman* | [bdd7523](https://github.com/metaeducation/ren-c/commit/bdd7523) [#CC-1545](https://github.com/rebol/rebol-issues/issues/1545)
- ``` Implement UDP protocol ``` *@zsx* | [f929c97](https://github.com/metaeducation/ren-c/commit/f929c97)
- ``` Incorporate /ONLY option for suppressing conditional block evaluation. ``` *@hostilefork* | [895c893](https://github.com/metaeducation/ren-c/commit/895c893)
- ``` Merge pull request #160 from hostilefork/fix-cc-1748 ``` *@carls* | [9cd51ab](https://github.com/metaeducation/ren-c/commit/9cd51ab) [#CC-1748](https://github.com/rebol/rebol-issues/issues/1748)
- ``` Merge pull request #156 from hostilefork/fix-cc-2068 ``` *@carls* | [ac9176a](https://github.com/metaeducation/ren-c/commit/ac9176a) [#CC-2068](https://github.com/rebol/rebol-issues/issues/2068)
- ``` Fix CC-2068 CC-1748 ``` *@carls* | [9cd51ab](https://github.com/metaeducation/ren-c/commit/9cd51ab) [9cd51ab](https://github.com/metaeducation/ren-c/commit/9cd51ab) [9cd51ab](https://github.com/metaeducation/ren-c/commit/9cd51ab) [9cd51ab](https://github.com/metaeducation/ren-c/commit/9cd51ab) [#CC-1748](https://github.com/rebol/rebol-issues/issues/1748)
- ``` Support async read from clipboard ``` *@zsx* | [038555b](https://github.com/metaeducation/ren-c/commit/038555b)
- ``` Merge branch 'fix-cc-2068' into community ``` *@ladislav* | [be2bd43](https://github.com/metaeducation/ren-c/commit/be2bd43) [#CC-2068](https://github.com/rebol/rebol-issues/issues/2068)
- ``` Merge branch 'fix-cc-1748' into community ``` *@ladislav* | [82011e2](https://github.com/metaeducation/ren-c/commit/82011e2) [#CC-1748](https://github.com/rebol/rebol-issues/issues/1748)
- ``` String & binary targets for /INTO in REDUCE+COMPOSE (CC #2081) ``` *@hostilefork* | [4f17ba6](https://github.com/metaeducation/ren-c/commit/4f17ba6) [#CC-2081](https://github.com/rebol/rebol-issues/issues/2081)
- ``` Make word lists of frames bare as suggested Prevent word duplication when appending to an object Fix CC#1979 Optimize the code to not use search Fix 'self handling described in CC#2076 Fix Collect_Object to not overwrite memory BUF_WORDS does not own. Without this fix, Collect_Object was causing crashes in 64-bit R3 Amend Init_Frame_Word to set OPTS_UNWORD option to the word added to the frame word list as suggested. ``` *@ladislav* | [5e58496](https://github.com/metaeducation/ren-c/commit/5e58496) [#CC-1979](https://github.com/rebol/rebol-issues/issues/1979) [#CC-2076](https://github.com/rebol/rebol-issues/issues/2076)
- ``` Prevent word duplication when appending to an object Fix CC#1979 Optimize the code to not use search Fix 'self handling described in CC#2076 Rebased on Collect_Obj fix to not cause crashes in 64-bit R3 ``` *@ladislav* | [4aa7772](https://github.com/metaeducation/ren-c/commit/4aa7772) [#CC-1979](https://github.com/rebol/rebol-issues/issues/1979) [#CC-2076](https://github.com/rebol/rebol-issues/issues/2076)
Expand Down Expand Up @@ -488,9 +478,13 @@ foo: function [s] [
- ``` Delete unimplemented TASK! stub ``` *@hostilefork* | [dfcd893](https://github.com/metaeducation/ren-c/commit/dfcd893)
- ``` Remove use of SPLIT from parser which fails on linux when used with a rule that contains THRU. ``` *@codebybrett* | [1e98be5](https://github.com/metaeducation/ren-c/commit/1e98be5)
- ``` Remove Markup Codec ``` *@hostilefork* | [4797130](https://github.com/metaeducation/ren-c/commit/4797130)
- ``` Get rid of RM as unix `remove` ``` *@hostilefork* | [2a7fcbb](https://github.com/metaeducation/ren-c/commit/2a7fcbb)
- ``` Get rid of UTYPE! stub, datatype=>symbol fix ``` *@hostilefork* | [a25c359](https://github.com/metaeducation/ren-c/commit/a25c359)
- ``` Get rid of RETURN/redo ``` *@BrianHawley* | [49b94e5](https://github.com/metaeducation/ren-c/commit/49b94e5) [trello](https://trello.com/c/YMAb89dv/)
- ``` Remove /NOW refinement from QUIT (CC#1743) ``` *@hostilefork* | [e93a5b4](https://github.com/metaeducation/ren-c/commit/e93a5b4) [#CC-1743](https://github.com/rebol/rebol-issues/issues/1743)
- ``` Get rid of Lit-Word decay (CC#2101, CC#1434) ``` *@hostilefork* | [f027870](https://github.com/metaeducation/ren-c/commit/f027870) [#CC-2101](https://github.com/rebol/rebol-issues/issues/2101) [#CC-1434](https://github.com/rebol/rebol-issues/issues/1434) [trello](https://trello.com/c/MVLLDYJW/)
- ``` Remove deprecated 'register' keyword ``` *@hostilefork* | [8e5b9b1](https://github.com/metaeducation/ren-c/commit/8e5b9b1)
- ``` Get rid of LOAD /next ``` *@BrianHawley* | [8da64f8](https://github.com/metaeducation/ren-c/commit/8da64f8)
- ``` Get rid of if/else ``` *@BrianHawley* | [23673df](https://github.com/metaeducation/ren-c/commit/23673df)
- ``` Remove message print when LOAD/NEXT is used. bug#2041 ``` *@ladislav* | [93b05f7](https://github.com/metaeducation/ren-c/commit/93b05f7)
## [R3-Alpha] - 12-Dec-2012
Expand Down
17 changes: 16 additions & 1 deletion scripts/changes-file/README.md
View file
Expand Up @@ -38,13 +38,17 @@ Using the `r3` binary built (from source) in this repo run the `make-changes-fil

../../make/r3 make-changes-file.reb

or from Rebol console:

>> do %make-changes-file.reb

This will now make a new CHANGES.md file with all latest notable changes.

## Requirements

- Git

NB. Due to bug in `CALL/OUTPUT` a workaround is currently in-place which means it requires a shell for redirection (outputs a %tmp-commit-log file which is then parsed)
NB. Currently only tested on Mac OSX & Linux.


## How does it work?
Expand All @@ -61,6 +65,11 @@ One of three things:
- Contains a CureCode reference (CC-1111, CC#1111 or similar)
- Is flagged in `cherry-pick-map.reb`

Some examples of notable commits:

* Move BROWSE into userspace, built upon CALL
* Make SET have /PAD semantics by default, add SET/SOME refinement

### How do i flag notable commit in cherry-pick-map?

Either a `yes` or with a `[]` block.
Expand Down Expand Up @@ -100,6 +109,12 @@ The Changes file has the following types:
- Removed (removed feature or deprecation)
- Security (security fix/change)

Some examples of notable commits (and how they're categorised):

* Blah blah blah.... ("Changed" type)
* Add blah blah... ("Added" type)
* Removed this... ("Removed" type)
* Fix to this bug... ("Fixed" type)

### So how do i add some example code to a change? And trello or wiki link?

Expand Down
14 changes: 6 additions & 8 deletions scripts/changes-file/changes-file.reb
View file
Expand Up @@ -6,13 +6,14 @@ Rebol [
author: "Barry Walsh (draegtun)"
date: 12-Jun-2017
;; needs: [2.102.0] ;; Ren/C
version: 0.1.4
version: 0.1.5
history: [
0.1.0 30-May-2017 {Protoype. Created initial cherry-pick-map from commits}
0.1.1 02-Jun-2017 {Refactored & extra annotations. Edited cherry-picks}
0.1.2 06-Jun-2017 {Modulised. CHANGES.md & CREDITS.md now passed as args}
0.1.3 08-Jun-2017 {More trello links & and adapted for repo under /scripts/changes-file}
0.1.4 12-June-2017 {Temp fix for CALL/OUTPUT}
0.1.4 12-Jun-2017 {Temp fix for CALL/OUTPUT}
0.1.5 14-Jun-2017 {Remove temp fix on CALL/OUTPUT}
]
license: {Apache License 2.0} ;; Same as Rebol 3
exports: [make-changes-file make-changes-block get-git-log]
Expand Down Expand Up @@ -52,13 +53,10 @@ url: [
get-git-log: function [
{Return Rebolised block of Ren/C `git log`}
][
;git-log: make string! 0
;call/shell/wait/output "GIT_PAGER=cat git log --pretty=format:'[commit: {%h} author: {%an} email: {%ae} date-string: {%ai} summary: {%s}]'" git-log
;split git-log newline
git-log: make string! 0
call/shell/wait/output "git log --pretty=format:'[commit: {%h} author: {%an} email: {%ae} date-string: {%ai} summary: {%s}]'" git-log
split git-log newline

;; temp fix for CALL/OUTPUT bug
call/shell/wait "git log --pretty=format:'[commit: {%h} author: {%an} email: {%ae} date-string: {%ai} summary: {%s}]' > tmp-commit-log"
read/lines %tmp-commit-log
]

make-changes-block: function [
Expand Down

0 comments on commit 7a1e396

Please sign in to comment.