diff --git a/dev/publish-packages.md b/dev/publish-packages.md new file mode 100644 index 000000000..bd2ead664 --- /dev/null +++ b/dev/publish-packages.md @@ -0,0 +1,86 @@ +## Release process + +There are different releases to make: +- opam +- github +- pip + +Additionnally, nightlies are automatically released from _master_ branch on https://kappalanguage.org/ + +### Opam +#### Test +```bash +opam install . +``` +... + +#### Setup version in git +set env var +```bash +VER=v4.1.3 && echo $VER +``` + +```bash +git tag -a $VER -m "Kappa Software Suite version $VER" && git push origin $VER +``` +Can use simple tag text: + + +if need to undo as some changes are necessary before full publish? + +```bash +git tag -d $VER && git push --delete origin $VER +``` + +#### Opam publish + +We publish all except kappa-webapp at the moment. (Let's add the webapp to opam when we are able to build it there.) + +```bash +opam publish kappa-agents.opam kappa-binaries.opam kappa-library.opam +``` + +enter token, if no valid token availaible, create with only public-repo permission + +then validate commit, validate the PR creation, check the CI + +if it fails fix things, push to master, remove and reset the tag and start again + + +TODO: webapp + + +### Github + +Create a new release draft + +- Title: +``` +Kappa Software Suite version 4.1.3 +``` + +- Text: +``` +v4.1.3 + +Kappa Software Suite version 4.1.3 +``` + +Set last release as previous tag, then click _Generate release notes_ and edit results to keep what's relevant + +Add files for: + +``` +Kappapp_for_linux.tar.gz +Kappapp_for_mac_os_10.15.zip +Kappapp_for_windows.zip +Source code (zip) +Source code (tar.gz) +``` + +electron are from nightly builds: https://tools.kappalanguage.org/nightly-builds/ +Source code from release tag https://github.com/Kappa-Dev/KappaTools/releases/tag/v4.1.3 + +### Pip + +TODO diff --git a/dev/tests/240618.md b/dev/tests/240618.md index 3b7519108..1fc78dd92 100644 --- a/dev/tests/240618.md +++ b/dev/tests/240618.md @@ -23,3 +23,9 @@ New tests 240724 Added output tab testing to procedure, tested on linux web and electron: ok + +240924 +Electron on MacOS, Windows, Linux: ok +Firefox on Linux: ok +Firefox on windows: ok +Chrome on MacOS: ok diff --git a/dev/tests/webapp.md b/dev/tests/webapp.md index 8172d8812..65c734110 100644 --- a/dev/tests/webapp.md +++ b/dev/tests/webapp.md @@ -15,7 +15,7 @@ Second level: what to check additionnally - open the app with argument `?level=debug`, open the browser console. If on electron, this is done by modifying `main.js`. use it in the following to check if operations trigger errors that would not be visible in the interface #### Load and editor -- load file https://tools.kappalanguage.org/try/?model=https%3A//raw.githubusercontent.com/Kappa-Dev/KappaTools/master/examples/abc.ka +- load file https://raw.githubusercontent.com/Kappa-Dev/KappaTools/master/examples/abc.ka - make an error in the file, for instance delete last character in line 21 `%obs: 'Cuu' |C(x1{u},x2{u})|` check that the error is displayed in the gutter on the left, and in the code underlined in red, and at the bottom right : `1/1[abc.ka] Illegal definition of variable 'Cuu' ` - undo the error e.g. ctrl+z @@ -32,7 +32,7 @@ Second level: what to check additionnally - Contact map is present, see that it changes when clicked on - interactive mode - show all states - zoom with mouse wheel, reset with button `Reset Zoom` - export to svg and check the picture -- Go to influences: is it populated? +- Go to influences: click on a Navgation control. does it populate?  - Change rendering to graph, change accuracy to high, see that it changes; play with size radius controls - Change back to Tabular, click Track cursor. click on different rules in the editor to see that it changes in the subpanel; click on previous/next similarly - export to json and check that info is present in the file @@ -53,15 +53,15 @@ Second level: what to check additionnally - Change to DIN tab, check that a table is populated and that we can switch to the second table - Export to json and check the file - Change to Snapshot tab, enter $SNAPSHOT in the Simulation perturbation and click intervention, see that the snapshot shows up -- Click on kappa and change display to graph, play with the graph settings +- Click on the selector with `kappa` and change display to `graph`, play with the graph settings - Change back to kappa, continue/pause the simulation, make a new snapshot, and test to switch between snapshot - Go to outputs, run `$PRINT "time: ".[T] > "time.txt"` and `$PRINT 'AB' > "ab.txt"` see that it shows up, run a bit the simulation, run one of them again, check that we can see all values - Go back to log tab and see the previous interventions show up -- Click on `All outputs` in the simutation, check that the following files are present and not empty: log.txt, inputs.ka, flux.json, flux.html, data.csv, snap and snap_xxxxxx +- Click on `All outputs` in the simulation controls at the bottom, check that the following files are present and not empty: log.txt, inputs.ka, flux.json, flux.html, data.csv, snap and snap_xxxxxx #### Files - Hit clear to clear up the simulation -- File>export and download the file as abc.ka +- File>export and download the file e.g. as abc.ka - Close the file, then file> open, open back the file - File> new enter a name as `test.ka`, fill with the contents: https://www.di.ens.fr/~feret/teaching/2023-2024/MPRI.2.19/activities/causality/causality_slide_10.ka - See the update of the contact map with both @@ -72,7 +72,7 @@ Second level: what to check additionnally - Click get trace at the bottom and check file, json with empty trace - If not done in previous section, Copy/paste in the editor https://www.di.ens.fr/~feret/teaching/2023-2024/MPRI.2.19/activities/causality/causality_slide_10.ka - Go to preferences, enable store trace, click Set -- clear/start the simulation, it stops because of last `%obs` +- clear/start the simulation, it stops because of last `%mod` - Click get trace at the bottom and check the file contains a non empty trace section (TODO: reference?) - Go to the stories tab, click launch - See that the computation log show up, that a story graph appears on the right