release v3.1.0 #62
Open
release v3.1.0 #62
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ci: adding pipeline for push on main branch. #48
…sted (#46) * fix(runner): require diagram format only when diagram export is requested. #42 Previously, the CLI required a diagram format to be specified even when diagram generation was not requested, causing unnecessary errors. Now, the --format argument is only required and validated when diagram export is explicitly requested, improving usability for users who only want to run justifications without generating diagrams. * fix(runner): dumping stderr on output when no format is given. #42
* feat(config): improve parsing of parameters and add unit tests. #45 Refactored the parameter parsing logic for better clarity and robustness. Added comprehensive unit tests to cover edge cases and ensure correct behavior for config file and CLI variable parsing. * feat(docs): update variable formatting notes in usage guide for improved parsing. #45 - Document support for JSON and Python literal syntax in variables - Add comprehensive examples with nested and mixed types - Clarify accepted formats for booleans, null, numbers, lists, dicts, and strings - Expand summary table and common mistakes section * test(e2e): add end-to-end tests and resources for complex, simple, missing producer, and skip scenarios. #45 Added E2E test suites and resource files for various pipeline scenarios, including complex success, simple success, missing producer, and skip scenario cases. * test(e2e): add tests for circular, self, missing consumer dependencies and exception handling. #44 - Added E2E tests and resources for circular dependency, self-dependency, missing consumer, and exception handling scenarios - Modified pipeline engine to add new error message on get order execution error * refactor: removing import duplication, indentation fix. #45
* feat: embed generated diagram image in PR comment using existing branch. #50 - Added inputs to optionally embed diagram images directly in PR comments - Users provide an existing branch name where image is committed - Action commits the generated image to the specified branch - PR comment embeds the image using a public raw GitHub URL - Default artifact upload behavior remains unchanged - Requires contents: write permission for the repo * feat(action): adding github-token input. #50 * feat(action): adding commit sha to image name and adding runner output to pr message. #50 * fix(action): accessing sha and skipping first 9 lines of output. #50 * fix(action): comment pr. #50 * feat(action): formating message. #50 * feat(action): renaming the folder where the image is save as the repository who trigger the pr. #50 * refactor(action): reducing complexity by using function and reducing duplication. #50 * feat(action): moving all run jobs into script files. #50 * feat(export_to_format): changing skip nodes and edges color. #50 * feat(action): improve PR comment formatting and document output trimming logic. #50 - Collapse the image and artifact in a details block on success, hiding all runner output - On error, remove the first 9 lines and all lines from the ASCII art onward from runner output - Add clear, precise documentation and maintainer notes to script/action/build_comment.sh - Warn maintainers to update trimming logic if runner output or ASCII art changes - Improve maintainability and clarity for future updates to PR comment formatting * feat: setting darker gray on skip and removing jpiperunner output table on error. #50 * feat(build_comment): strip the ascii colors and adding complete documentation for the script. #50 * docs(action): add detailed documentation to run_jpipe.sh and commit_diagram.sh. #50 - Add clear, structured comments and maintainer notes to script/action/run_jpipe.sh and script/action/commit_diagram.sh - Explain environment variables, execution flow, and maintenance considerations - Improve clarity and maintainability for future contributors * feat(docs): add detailed usage and configuration guide for jPipe Runner GitHub Action. #50 - Document required, conditional, and optional inputs with tables - Explain permissions, secrets, and workflow setup - Add section on output log cleaning in �uild_comment.sh, including maintenance notes for ASCII banners and logo detection - Provide usage notes for embedding images and artifact handling * feat(action): handling workflow trigger outside a pr context and updating documentation. #50 * fix(action): replacing `#` to `//`. #50
* feat(commit_diagram): now the action will automatically create the branch if it doesn't exist. #51 * feat: allowing raw image on private repo with temporary access token * fix: github bot creation branch authorisaion. #51 * fix: build_comment is know having access to githbu token. #51 * feat(action): add optional parameter github-readonly-token for raw generation and update documentation. #51 - Add github-readonly-token parameter to action inputs - Update build_comment.sh to use read-only token if provided (for raw generation), fallback to default token - Document new input and usage in ACTION.md * docs: adding token permissions in descriptino and documentation. #51
BaptisteLacroix
added
documentation
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
chore(release): v3.1.0
Features
config.yamland CLI Variables #45)Fixes
--libraryargument silently ignores missing files #58)Docs
CONTRIBUTING.mdfor Project Guidelines #43)Summary
Closes #63