From 295ac8cea07fe9cd62954fb9b9f32d153334d923 Mon Sep 17 00:00:00 2001 From: thc202 Date: Tue, 23 Apr 2024 17:37:03 +0100 Subject: [PATCH] Add changelog and mention exit value Add changelog and document the exit value of the action. Signed-off-by: thc202 --- CHANGELOG.md | 11 +++++++++++ README.md | 4 ++++ 2 files changed, 15 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e42b9ff --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this GitHub action will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +## [Unreleased] +### Added + - Allow to run local or remote Automation Framework plans. + +[Unreleased]: https://github.com/zaproxy/action-af/compare/b9d155d1940506fe73c356194bbc0dc4f45789f4...HEAD diff --git a/README.md b/README.md index ab9c19b..02d08fd 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ A GitHub Action for running [ZAP Automation Framework](https://www.zaproxy.org/d **Optional** Additional [command line options](https://www.zaproxy.org/docs/desktop/cmdline/) for ZAP. +## Exit Value + +The action will exit with the value of the plan, as indicated in the [Automation Framework documentation](https://www.zaproxy.org/docs/automate/automation-framework/#exit-value). + ## Files Files created with the plan that need to be used after the plan has finished should be saved to the `/zap/wrk/` directory, which is mapped to the [GITHUB_WORKSPACE](https://docs.github.com/en/actions/learn-github-actions/variables) directory.