From e979a7eeefca0046430beb69c2500face716b8e1 Mon Sep 17 00:00:00 2001 From: arcuri82 Date: Fri, 5 Apr 2024 13:13:33 +0200 Subject: [PATCH] adding release notes --- .github/workflows/ci.yml | 1 + .github/workflows/release.yml | 1 + docs/release.md | 4 ++++ release_notes.md | 36 +++++++++++++++++++++++++++++++++++ 4 files changed, 42 insertions(+) create mode 100644 release_notes.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2c68d7ce9c..fbb37a6859 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,6 +19,7 @@ on: - '!LICENSE' - '!.gitignore' - '!docs/**' + - '!release_notes.md' - 'docs/options.md' ### Unfortunately, had to disable this. Originally added to be able to run CI from PRs from forks (eg from external people). ### But this leads to run CI 2 twice on each push on an open PR, regardless of fork. diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f3941b7339..d46b626b7f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -159,6 +159,7 @@ jobs: - name: Release uses: softprops/action-gh-release@v1 with: + body: "See release notes at release_notes.md" prerelease: false draft: false fail_on_unmatched_files: true diff --git a/docs/release.md b/docs/release.md index f0cc87300a..d1a3add50e 100644 --- a/docs/release.md +++ b/docs/release.md @@ -83,6 +83,10 @@ However, it might take some hours before those are in sync with Maven Central, which you can check at [https://search.maven.org/](https://search.maven.org/). +## Release Notes + +Update the release notes (i.e., the `release_notes.md` file), by replacing the SNAPSHOT version with the new release version. + ## GitHub Release Push the version changes in the `pom.xml` files on Git. diff --git a/release_notes.md b/release_notes.md new file mode 100644 index 0000000000..99a447796a --- /dev/null +++ b/release_notes.md @@ -0,0 +1,36 @@ +# Version: SNAPSHOT + +### Breaking Changes +- Authentication credential definitions have been overhauled. This breaks current white-box drivers. For example, `AuthenticationDto` is now moved into a `auth` sub-package, i.e., `org.evomaster.client.java.controller.api.dto.auth`. Cookie and token based authentication definitions are now replaced with `LoginEndpointDto`. See new [auth documentation](docs/auth.md). +- SQL related configuration DTOs have been moved into new `org.evomaster.client.java.sql` package from old naming `org.evomaster.client.java.controller.db`. + +### New Features +- Handling configuration files to specify _options parameters_ and _authentication credentials_ (especially needed for black-box testing). An empty `em.yaml` file is now created automatically if missing, with documentation as comments. Location can be changed with `--configPath` option. +- Possibility to filter endpoints to fuzz based on their OpenAPI tags (using `--endpointTagFilter`). +- Bypassing HTTPS checks. Now it is possible to fuzz APIs using HTTPS where their certificates are expired or invalid. + +### White-Box Improvements +- Handling of `Base64.getDecoder()` +- Handling of `@Email` javax constraints + +### Bug Fixes + +- fixed wrong number of covered endpoints in console logs +- fixed issues in reading OpenAPI schemas from file-system on Windows +- fixed issues related to endpoint definitions ending with a `/`, e.g., `/foo` and `/foo/` are technically 2 different endpoints. + +### Addressed GitHub Issues +- #701: EvoMaster process terminated abruptly when using BlackBox and a local file for schema +- #759: Cannot find EvoMaster_Test.java file in the output folder +- #820: OpenApi spec default value is ignored +- #862: Errors while saving tests to src/em +- #873: Bug in GraphQL Blackbox mode +- #906: WTSAlgorithm Crossover Bug +- #914: duplicate of #701 + +--- +# Version 2.0.0 and Earlier + +Unfortunately, we only started in 2024 to write release notes. +There is no release notes for older versions of _EvoMaster_. +