Create an automated release workflow

[lhstrh]

We should have a script that will make it easier to update our version numbers. Here are the relevant commits 18743fe db1602f that show the locations that have to be touched.

The script could take two arguments: the current version string and the new version string. The script should first perform a dry run and show all the changes. If the user confirms the changes are OK, commit them.

[lhstrh]

On a related note, there exist some files in the repository that should not be committed accidentally contributors unless they are updating the base configuration (potentially as part of a version update). These files should be listed in .gitignore and only (forcefully) updated when this is really the intention. Let's first try to come up with an exhaustive list:

• org.lflang.targetplatform/org.lflang.targetplatform.target
• ...

[lhstrh]

@a-sr mentioned: Gradle/Eclipse might have functionality for this. Python script exists for Kieler.

[a-sr]

This is the Python script for setting the version in Kieler: https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/semantics/browse/build/scripts/version.py

[lhstrh]

A private release-tools repository has been instantiated, and I'm working on an automated workflow that bumps version numbers, updates release notes, runs tests, create tags, and creates releases.

[lhstrh]

I found out that OSGi does not allow versions like 0.1.0-beta; it only allows 0.1.0 or 0.1.0.qualifier (the latter is synonymous with -SNAPSHOT in Maven). This means that until we are done publishing prereleases, we should just stick with 0.1.0.qualifier (OSGi) and 0.1.0-SNAPSHOT (Maven). The workflows I started working on will not be usable until we are ready for 0.1.0. This means we should move the completion of this task to our next milestone. We'll just publish 0.1.0-beta manually.

[lhstrh]

How does this look for an automatically generated change log? Note that the first couple links don't work because the release hasn't been tagged yet. I encourage everyone to have a careful look the log below and correct/improve any PR or issue titles that are unclear. We can also do a better job categorizing PRs by labeling them. Any PRs that should not be included can be marked as such add the exclude label to them (more specifically, PRs that have any of the following labels are excluded: trivial, duplicate, question, invalid, wontfix, ci, exclude.

Changelog

v0.1.0 (2022-03-20)

Summary:

This is the first stable release of Lingua Franca. A number of new features have been introduced since v0.1.0-beta, including: generation of ROS2 nodes directly from LF code (C++); improved error handling; support for multiports and banks (TypeScript); modular support for runtime schedulers (C); and modal reactors (C and Python). Finally, a major refactoring has been performed in which all remaining Xtend code was ported to Java.

Full Changelog

Implemented enhancements:

• Add a -v / --version flag to lfc #927
• Produce informative message when lfc is run on non-LF files #919
• Make Docker generation compatible with the files target property #887 #987
• Preconfigure Epoch with example projects #374
• In banks of reactors, make bank_index a proper parameter #343
• Align the meaning of the threads target property across targets #290
• Improve Stability of Positioning Edges connected to Reactions in Diagrams #1040 (a-sr)
• Improve layout options #1015 (soerendomroes)
• Support modal models in Python #1009 (edwardalee)
• Replace the 'threads' target property with the 'workers' and 'threading' properties #993 (cmnrd)
• Enable generation of ROS2 nodes directly from C++ code #984 (cmnrd)
• Added --version flag to lfcand improved error messages #979 (cmnrd)
• Improve warning message for unrecognized target parameters #964 (cmnrd)
• Add bank & multiport support in TypeScript code generator with > 30 multiport tests. #942 (hokeun)
• Added support for modular scheduler in C runtime #743 (Soroosh129)
• Added support for Modal Models #501 (a-sr)

Fixed bugs:

• Maven build is broken #1033
• FilterBank benchmark in C++ has cycles #1031
• EclipseErrorReporter reports errors in the wrong file #1030
• Dependency cycle detection does not seem to work #1024
• Spurious warnings in Epoch #1016
• Error reporting in Epoch is broken #994
• Epoch fails to highlight errors on codegen #966
• Some cargo errors are not reported in LF #936
• Files without main don't compile if they have imports #913
• Invalid time literal causees IllegalArgumentException #908
• Reactor extending itself causes StackOverflowError #907
• Having multiple unnamed main reactors causes nullPointerException #905
• Catch errors from the TS type checker in the examples category #405
• Fix errors in tracing util. #1043 (hokeun)
• Properly recognize network message actions in TypeScript generator #1042 (hokeun)
• [error reporting] Correct bugs reported on Epoch #1038 (petervdonovan)
• Fix handling of ganged connections #1037 (edwardalee)
• Broaden a pylint ignore. #1029 (petervdonovan)
• Fixed causality loop detection bug #1026 (edwardalee)
• Suppress line-too-long warnings in the Python target. #1018 (petervdonovan)
• [C] do not generate code without main reactor #1000 (housengw)
• Check for null reactor to avoid NPE #998 (edwardalee)
• Fix eclipse error reporting #995 (cmnrd)
• Epoch error reporting #967 (edwardalee)
• Detect and flag and as error multiple mains #965 (edwardalee)
• Inheritance cleanups #962 (edwardalee)
• Fixes Extra folders generated for main reactors in imported files in the Python target #768 #952 (housengw)
• Report raw, unparsed error streams as a last resort. #941 (petervdonovan)

Closed issues:

• Epoch fails on valid file #1027
• List modal reactor tests in own test category #1020
• Merge JavaAstUtils and ASTUtils #1003
• Kotlin classes do not get build by buildLfc task (unless the clean task is also run) #930
• Port Xtend classes to Java #838
• Use the same implementation of deque accross all C benchmarks #765
• Use the BenchmarkRunner reactor in all C benchmarks #764
• Build both Epoch with maven and lfc with gradle in our CI workflow #575
• C syntax for referencing parameters and state variables #82

Merged pull requests:

• Removed all Xtend dependencies #1051 (housengw)
• Removed broken dependency on org.eclipse.xpand.feature.group #1050 (lhstrh)
• Port CGenerator.xtend to Java #1049 (housengw)
• Replace all tabs with spaces in the org.lflang.diagrams package #1047 (a-sr)
• Partial refactoring of CGenerator.xtend #1045 (housengw)
• Another refactoring of CGenerator.xtend #1035 (housengw)
• ASTUtils cleanup #1022 (cmnrd)
• Bump Xtext from 2.25.0 to 2.26.0 #1021 (lhstrh)
• Removed unnecessary xtend-gen folder from classpath #1014 (soerendomroes)
• Added ROS2 serialization tests #1012 (Soroosh129)
• Refactor CGenerator.xtend #1011 (housengw)
• Grammar cleanup #1008 (cmnrd)
• Merge JavaAstUtils into ASTUtils #1004 (housengw)
• Move benchmarks to separate repository #1001 (cmnrd)
• Add FPS and update README of YOLO demo #989 (housengw)
• Carla intersection refactoring #982 (housengw)
• FileConfig cleanups #978 (cmnrd)
• Add invoke_deadline_handler parameter to AnytimePrime.lf. #976 (hokeun)
• Port GeneratorBase.xtend to Java #974 (housengw)
• Add reactor-cpp as a submodule and reorganize the C++ build process #971 (cmnrd)
• Simplify conditional fed codegen #970 (edwardalee)
• Fix port type mismatch in AnytimePrime.lf #968 (hokeun)
• FileConfig cleanup #963 (cmnrd)
• Validator cleanups #961 (edwardalee)
• Add C code generation to store currently executed reaction, add AnytimePrime.lf as a demo for check_deadline(). #960 (hokeun)
• Ported PythonGenerator.xtend to Java and started refactoring of GeneratorBase #958 (housengw)
• Clean up the file writing mechanism #956 (cmnrd)
• Port org.lflang.federated to java #950 (housengw)
• Fixed bug in centralized coordination related to time advancement #949 (housengw)
• Update reactor-cpp version #946 (cmnrd)
• Ported Xtend code in diagram package to Java #940 (housengw)
• Refactoring: Purge code generators of IFileSystemAccess2. #938 (petervdonovan)
• Fix gradle setup by setting kotlin version to 1.4.30 #934 (cmnrd)
• Fixes Very strange error in C tests #932 #933 (Soroosh129)
• Carla intersection updates #901 (Soroosh129)
• Ported LFValidator.xtend to Java #886 (housengw)
• Added AlarmClock example #780 (revol-xut)