`copilot`: Changelogs follow inconsistent format

[ivanperez-keera]

Description

The CHANGELOGs contain lines with irregular formatting. It should be:

Comment. (#<issuenumber>)

but instead sometimes is:

Command (#<issuenumber)>.

Type

• Bug: Inconsistent format used in CHANGELOGs.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

Running the following command lists all lines with the inconsistent formatting:

$ grep -nHre '#[0-9]\+)\.$' copilot**/CHANGELOG
copilot-c99/CHANGELOG:21:        * Print constants in tests using portable suffixes. (#471).
copilot-c99/CHANGELOG:115:        * Implemented arrays in test driver (#176).
copilot-c99/CHANGELOG:116:        * Fixed nested array initialisation bug (#173).
copilot-c99/CHANGELOG:117:        * Fixed length of buffer allocation for n-dimensional arrays (#174).
copilot-c99/CHANGELOG:118:        * Fixed printing of long ints in test suite (#177).
copilot-c99/CHANGELOG:119:        * Fixed printing of unsigned ints in test suite (#177).
copilot-c99/CHANGELOG:120:        * Fixed '-Wsequence-point' warnings from GCC (#179).
copilot-c99/CHANGELOG:121:        * Split Property.hs (#180).
copilot-c99/CHANGELOG:122:        * Removed 'Test' from module paths (#181).
copilot-c99/CHANGELOG:123:        * Made compiletest take compiler options as an argument (#182).
copilot-c99/CHANGELOG:124:        * Fixed problem with property and empty string in driver CSV (#183).
copilot-c99/CHANGELOG:125:        * Added comma to output of driver to match the interpreter (#184).
copilot-c99/CHANGELOG:126:        * Implemented basic quickcheck based testing (#185).
copilot-c99/CHANGELOG:135:        * Fixed bug with constant structs and arrays.(#200).
copilot-c99/CHANGELOG:139:        * Remove ExternFun (#207).
copilot-c99/CHANGELOG:140:        * Fix bug in code generation for local expression (#198).
copilot-c99/CHANGELOG:141:        * Implement code generation for labels (trivially) (#199).
copilot/CHANGELOG:2:        * Update contribution guidelines (#476).
copilot/CHANGELOG:123:          versions. (#61).
copilot/CHANGELOG:124:        * Add Ivan Perez as co-maintainer (#51).
copilot/CHANGELOG:125:        * Update description in cabal file to match copilot-core (#50).
copilot/CHANGELOG:129:        * Update multiple examples (#41).
copilot/CHANGELOG:130:        * Update instructions to match new repositry name (#45).
copilot-core/CHANGELOG:141:        * Fixed implementation of tysize for n-dimensional arrays. (#147).
copilot-core/CHANGELOG:142:        * Removed sorting of interpreter output (#148).
copilot-core/CHANGELOG:143:        * Minor documentation fixes (#149, #151).
copilot-core/CHANGELOG:148:        * Eliminate random modules and generators (#157).
copilot-core/CHANGELOG:149:        * Updated contact information for 'impossible' error (#154).
copilot-core/CHANGELOG:150:        * Implement missing pretty printer for Index operator (#155).
copilot-language/CHANGELOG:112:        * Fixed the reverse order of triggers (#114).
copilot-language/CHANGELOG:114:          (#116).
copilot-language/CHANGELOG:115:        * Bump ghc-prim version bounds (#122).
copilot-language/CHANGELOG:119:        * Remove ExternFun (#118).
copilot-libraries/CHANGELOG:91:        * Update description, bug-reports, homepage fields in cabal file (#129).
copilot-theorem/CHANGELOG:92:        * Version bump (3.3). (#217).
copilot-theorem/CHANGELOG:93:        * Adjust contraints on version of what4. (#90).
copilot-theorem/CHANGELOG:96:        * Version bump (3.2.1). (#92).
copilot-theorem/CHANGELOG:97:        * Completed the documentation. (#95, #93).
copilot-theorem/CHANGELOG:102:          (#97).
copilot-theorem/CHANGELOG:106:        * Remove ExternFun (#99).

Expected result

Running the command above reports no lines, indicating that the format being used does not have that inconsistency.

Desired result

Running the command above reports no lines, indicating that the format being used does not have that inconsistency.

Proposed solution

Replace all lines that have that inconsistent formatting to use the format:

Comment. (#<issue_number>)

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for fixing in Copilot 4.1.

Fix assigned to: @ivanperez-keera .

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:

  • [X] The code proposed compiles and passes all tests. Details: Build log: https://app.travis-ci.com/github/Copilot-Language/copilot/builds/272804597
  • [X] The solution proposed produces the expected result. Details: Running the Dockerfile below prints the message Success, indicating that there are no lines in any changelog where the issue number is followed by a period, where it follows anything other than a period or spaces, or where the date that denotes a new change block has anything after the day. Spaces are only needed when the issue number is the first element in a line, which is caused by line wrapping.

    
    FROM ubuntu:focal

  ENV DEBIAN_FRONTEND=noninteractive RUN apt-get update

  RUN apt-get install --yes git

  SHELL ["/bin/bash", "-c"]

  CMD git clone $REPO \ && cd $NAME \ && git checkout $COMMIT \ && ! grep -e '#[0-9]+).$' copilot/CHANGELOG \ && ! grep -e '[^. ] (#[0-9]+)' copilot/CHANGELOG \ && ! grep -e '^202[0-9]-[0-9]{2}-[0-9]{2}.' copilot**/CHANGELOG \ && echo Success

  Command (substitute variables based on new path after merge):

  $ docker run -e "REPO=https://github.com/ivanperez-keera/copilot" -e "NAME=copilot" -e "COMMIT=578eff68a4a59a4e99b3179fbf5d47e97881ee07" -it copilot-verify-550

• [X] Implementation is documented. Details: No updates needed. Change is to the changelogs.
• [X] Change history is clear.
• [X] Commit messages are clear.
• [X] Changelogs are updated.
• [X] Examples are updated. Details: No updates needed. Change is to the changelogs.
• [X] Required version bumps are evaluated. Details: No bump needed. Change is to the changelogs.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.