feat: update dev-tools documentation #1298
Merged
Conversation
This file contains 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
github-actions
bot
added
documentation
sdo-1A
force-pushed
the
feat/update-devtools-doc
branch
from
c25f14b to
56e6a70
Compare
cpaulve-1A
reviewed
Jan 30, 2024
docs/dev-tools/DEV_TOOLS.md
Outdated
| @@ -1,272 +1,16 @@ | |||
| # Otter utils library | |||
|
|
|||
| Collection of tools to help to main a project with Otter Library | |||
| The Otter Framework provides a collection of tools to help to main a project with Otter Library | |||
There was a problem hiding this comment.
Suggested change
| The Otter Framework provides a collection of tools to help to main a project with Otter Library | |
| The Otter Framework provides a collection of tools to help your Otter's project maintenance |
fpaul-1A
reviewed
Jan 30, 2024
cpaulve-1A
reviewed
Jan 30, 2024
packages/@o3r/azure-tools/README.md
Outdated
| @@ -3,32 +3,60 @@ | |||
| <img src="https://raw.githubusercontent.com/AmadeusITGroup/otter/main/assets/logo/otter.png" alt="Super cute Otter!" width="40%"/> | |||
| </p> | |||
|
|
|||
| This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/otter/tree/main/docs/core/MODULE.md). | |||
| <br /> | |||
kpanot
reviewed
Jan 30, 2024
| | `--basicAuth <base64>` | `-b` | `string` | | Base64 encoding of username:password (password already encrypted from artifactory UI) | | ||
| | `--dry-run <dryRun>` | | `boolean` | `false` | List all files that would be deleted without actually deleting them | | ||
| | `--duration-kept <durationKept>` | `-d` | `number` | `1` | All artifacts older than this value (in days) will be deleted | | ||
| | `--pr-versions <prVersions>` | `-pr` | `number` | `1` | Number of PR versions that will be kept | |
There was a problem hiding this comment.
Is -pr working? it is not considered as -p -r?
There was a problem hiding this comment.
I tested and -pr is working yes, but I can change the alias to a single letter if you prefer (like -n for example since we want the number of PR versions to keep)
There was a problem hiding this comment.
I think changing the alias would be actually safer
sdo-1A
force-pushed
the
feat/update-devtools-doc
branch
2 times, most recently
from
496d043 to
57a87f9
Compare
| @@ -20,7 +20,7 @@ program | |||
| .choices(['Replace', 'Add', 'Skip']) | |||
| .default('Add') | |||
| ) | |||
| .option('-I, --threadIdentifier <threadIdentifier>', 'Thread identifier', undefined) | |||
| .requiredOption('-I, --threadIdentifier <threadIdentifier>', 'Thread identifier') | |||
There was a problem hiding this comment.
threadIdentifier should not be mandatory in case of mode="Add" (the default case)
There was a problem hiding this comment.
I made it mandatory since it is passed as a parameter to the function findThreadsByIdentifier on line 65 and this parameter is of type string:
There was a problem hiding this comment.
const threads = opts.threadIdentifier ? await prService.findThreadsByIdentifier(repositoryId, pullRequestId, opts.threadIdentifier) : [];
sdo-1A
force-pushed
the
feat/update-devtools-doc
branch
from
57a87f9 to
a34b790
Compare
matthieu-crouzet
approved these changes
Feb 2, 2024
fpaul-1A
approved these changes
Feb 5, 2024
kpanot
approved these changes
Feb 5, 2024
cpaulve-1A
approved these changes
Feb 5, 2024
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.
Proposed change
Update the documentation in the dev-tools package and the new packages during the dev-tools split. Some breaking changes are made as well.