From 26c3dadd6b204599bba9fc3217718f0407f176a1 Mon Sep 17 00:00:00 2001 From: Armin Date: Mon, 13 Jul 2020 11:29:37 +0200 Subject: [PATCH] V2.5.0 renamed save-generated-files to set-build-path --- README.md | 18 ++++++++---------- action.yml | 6 +++--- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c580b36..59638b7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # arduino-test-compile [action](https://github.com/marketplace/actions/test-compile-for-arduino) / script -### Version 2.5.1 +### Version 2.5.2 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) [![Build Status](https://github.com/ArminJo/arduino-test-compile/workflows/arduino-test-compile-ActionTest/badge.svg)](https://github.com/ArminJo/arduino-test-compile/actions) @@ -10,6 +10,7 @@ It can be used e.g. to test-compile all examples contained in an [Arduino librar The action is a Docker action which uses Ubuntu 18.04 and the [arduino-cli program](https://github.com/arduino/arduino-cli) for compiling. All the other work like loading libraries, installing board definitions and setting parameters is orchestrated by the [arduino-test-compile.sh](arduino-test-compile.sh) bash script.
In case of a compile error the [**complete compile output**](https://github.com/ArminJo/PlayRtttl/runs/692586646?check_suite_focus=true#step:4:99) is logged in the [Compile all examples](https://github.com/ArminJo/PlayRtttl/runs/692586646?check_suite_focus=true#step:4:1) step, otherwise only a [**green check**](https://github.com/ArminJo/PlayRtttl/runs/692736061?check_suite_focus=true#step:4:95) is printed.
If you want to test compile a sketch, **it is not required that the sketch resides in a directory with the same name (as Arduino IDE requires it) or has the extension .ino**. Internally the file is renamed to be .ino and the appropriate directory is created on the fly at `/home/runner/` for test-compiling. See [parameter `sketch-names`](arduino-test-compile#sketch-names).
+Since version 0.11.0 of arduino-cli, the **generated files** (.bin, .hex, .elf, .eep etc.) can be found in the build/ subfolder of the example directory `$GITHUB_WORKSPACE/src/` or in `$HOME/` for files not residing in a directory with the same name.
# Hints - If you require a custom library for your build, add an extra step for [loading a custom library](#using-custom-library). **Be aware to use the `path:` parameter for checkout, otherwise checkout will overwrite the last checkout content.**
@@ -164,10 +165,9 @@ Environment name for script usage is `ENV_SKETCH_NAMES_FIND_START`. sketch-names-find-start: digistump-avr/libraries/*/examples/C*/ ``` -### `save-generated-files` -If set to true, the **generated files** (.bin, .hex, .elf etc.) can be found in the example directory `/home/runner/work///src/` = `$GITHUB_WORKSPACE/src/` or in `/home/runner/` = `$HOME/` for files not residing in a directory with the same name.
-Because of an [arduino-cli bug](https://github.com/arduino/arduino-cli/issues/821) this function is **incompatible with examples having local *.h files**.
-Default is `false` (compatible with local *.h files).
+### `set-build-path` +If set to true, the build directory (arduino-cli paramer --build-path) is set to `$GITHUB_WORKSPACE/src//build/` or to `$HOME//build/` for files not residing in a directory with the same name.
+Default is `false`.
Environment name for script usage is `ENV_SAVE_GENERATED_FILES`. ```yaml @@ -422,14 +422,12 @@ Samples for using `arduino-test-compile.sh script` instead of `ArminJo/arduino-t - Arduino library, multiple boards. NeoPatterns [![Build Status](https://github.com/ArminJo/NeoPatterns/workflows/LibraryBuild/badge.svg)](https://github.com/ArminJo/NeoPatterns/blob/master/.github/workflows/LibraryBuild.yml) # Revision History -### Version v2.5.1 -- Improved error and debug flags handling. -### Version v2.5.0 -- Build result files (and build temporary files) are now stored in the build source directory by internally using cli parameter *--build-path*. +### Version v2.5.0 -> Due to a Github failure/outage on 13.07.2020 the old 2.5.0 version from 10.07.20 (and 2.5.1 from 12.07.20 ) was removed. - Fixed skipped compile of examples, if one *.ino file is present in the repository root. - `examples-build-properties` now used also for **c and S* extra_flags. -- Added `save-generated-files` parameter. +- Improved error and debug flags handling. +- Added `set-build-path`. ### Version v2.4.1 - Only search for files when using `sketch-names`. diff --git a/action.yml b/action.yml index 4e4a908..ca9ea8a 100644 --- a/action.yml +++ b/action.yml @@ -55,8 +55,8 @@ inputs: default: '' required: false - save-generated-files: - description: 'Flag to save the generated files (.bin, .hex, .elf etc.) in the example directory. Is introduced because of a cli bug https://github.com/arduino/arduino-cli/issues/821' + set-build-path: + description: 'Flag to set the build directory (arduino-cli paramer --build-path) to /build subdirectory of compiled example.' default: 'false' required: false @@ -84,7 +84,7 @@ runs: - ${{ inputs.required-libraries }} - ${{ inputs.examples-exclude }} - ${{ inputs.examples-build-properties }} - - ${{ inputs.save-generated-files }} + - ${{ inputs.set-build-path }} - ${{ inputs.debug-compile }} - ${{ inputs.debug-install }}