From 3aff2446367db02741946dcfc511405a64c2fa6c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sun, 6 Aug 2023 17:26:25 +0000 Subject: [PATCH] Docs changes --- docs/ActionList.md | 88 ++++++++++----------- docs/RepoM.Plugin.AzureDevOps.md | 16 ++-- docs/RepoM.Plugin.Clipboard.md | 8 +- docs/RepoM.Plugin.EverythingFileSearch.md | 6 +- docs/RepoM.Plugin.Heidi.md | 12 +-- docs/RepoM.Plugin.LuceneQueryParser.md | 6 +- docs/RepoM.Plugin.SonarCloud.md | 12 +-- docs/RepoM.Plugin.Statistics.md | 6 +- docs/RepoM.Plugin.WindowsExplorerGitInfo.md | 6 +- 9 files changed, 80 insertions(+), 80 deletions(-) diff --git a/docs/ActionList.md b/docs/ActionList.md index 8d887994..ee1c8909 100644 --- a/docs/ActionList.md +++ b/docs/ActionList.md @@ -2,22 +2,22 @@ Most of the repository actions are part of the core of RepoM and some are part of external plugins. All these repository actions have the same base: -Properties: +Properties: - `type`: RepositoryAction type. Should be a fixed value used to determine the action type. (required, string) - `name`: Name of the action. This is shown in the UI of RepoM. (required, evaluated, string) - `active`: Is the action active (ie. visible) or not. (optional, evaluated, boolean, default: `true`) -- `variables`: A set of variables to be availabe within this action. (optional, list`1) +- `variables`: A set of variables to be availabe within this action. (optional, list`1) The following actions are part of the core of RepoM and can always be used in your RepositoryActions. ## just-text@1 -Textual action to display some text in the action menu. +Textual action to display some text in the action menu. Action specific properties: -- `enabled`: Show the menu as enabled (clickable) or disabled. (optional, evaluated, boolean, default: `true`) +- `enabled`: Show the menu as enabled (clickable) or disabled. (optional, evaluated, boolean, default: `true`) Example: @@ -40,12 +40,12 @@ repository-actions: ## associate-file@1 -Action menu for opening files with a given extension. If files within the repository are found matching the extension, a submenu will be created with all matched files. +Action menu for opening files with a given extension. If files within the repository are found matching the extension, a submenu will be created with all matched files. Action specific properties: - `extension`: The file extension to look for. This parameter can contain a combination of valid literal path and wildcard (`*` and `?`) characters, but it doesnt support regular expressions. -For example `*.sln`. (required, string) +For example `*.sln`. (required, string) Example: @@ -69,11 +69,11 @@ repository-actions: ## browse-repository@1 -Action to open the default webbrowser and go to the origin remote webinterface. When multple remotes are available a sub menu is created for each remote. +Action to open the default webbrowser and go to the origin remote webinterface. When multple remotes are available a sub menu is created for each remote. Action specific properties: -- `first-only`: Property specifying only a menu item for the first remote is created. (optional, evaluated, boolean) +- `first-only`: Property specifying only a menu item for the first remote is created. (optional, evaluated, boolean) Example: @@ -93,11 +93,11 @@ repository-actions: ## browser@1 -Action opening a webbrowser with the provided url. +Action opening a webbrowser with the provided url. Action specific properties: -- `url`: The url to browse to. (required, evaluated, string) +- `url`: The url to browse to. (required, evaluated, string) Example: @@ -121,12 +121,12 @@ repository-actions: ## command@1 -Action to excute a command (related the the repository) +Action to excute a command (related the the repository) Action specific properties: - `command`: The command to execute. (required, evaluated, string) -- `arguments`: Arguments for the command. (optional, evaluated, string) +- `arguments`: Arguments for the command. (optional, evaluated, string) Example: @@ -152,12 +152,12 @@ repository-actions: ## executable@1 -Action to excute an application with additional arguments. This action is almost identical to the `command@1` action. When no existing executables are provided, the action will not show. +Action to excute an application with additional arguments. This action is almost identical to the `command@1` action. When no existing executables are provided, the action will not show. Action specific properties: - `executables`: Set of possible executables. The first executable that exists will be used. The paths should absolute. (required, evaluated, string) -- `arguments`: Arguments for the executable. (optional, evaluated, string) +- `arguments`: Arguments for the executable. (optional, evaluated, string) When you want to specify exacly one executable, you can replace the required property `Executables` with the following property: @@ -207,11 +207,11 @@ repository-actions: ## folder@1 -Action to create a folder (sub menu) in the context menu of the repository allowing you to order actions. +Action to create a folder (sub menu) in the context menu of the repository allowing you to order actions. Action specific properties: -- `items`: Menu items. (required, evaluated, list`1) +- `items`: Menu items. (required, evaluated, list`1) Example: @@ -243,14 +243,14 @@ repository-actions: ## foreach@1 -Action to create repeated actions based on a variable. +Action to create repeated actions based on a variable. Action specific properties: - `enumerable`: The list of items to enumerate on. (required, evaluated, string) - `variable`: The name of the variable to access to current enumeration of the items. For each iteration, the variable `{var.name}` has the value of the current iteration. (required, evaluated, string) - `skip`: Predicate to skip the current item. (optional, evaluated, string) -- `actions`: List of repeated actions. (required, evaluated, ienumerable`1) +- `actions`: List of repeated actions. (required, evaluated, ienumerable`1) Example: @@ -284,9 +284,9 @@ repository-actions: ## git-checkout@1 -This action will create a menu and sub menus with all local and remote branches for an easy checkout. +This action will create a menu and sub menus with all local and remote branches for an easy checkout. -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -306,9 +306,9 @@ repository-actions: ## git-fetch@1 -Action to execute a `git fetch` command. +Action to execute a `git fetch` command. -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -328,9 +328,9 @@ repository-actions: ## git-pull@1 -Action to execute a `git pull` command. +Action to execute a `git pull` command. -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -350,9 +350,9 @@ repository-actions: ## git-push@1 -Action to execute a `git push` command. +Action to execute a `git push` command. -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -372,10 +372,10 @@ repository-actions: ## ignore-repository@1 -Action to ignore the current repository. This repository will be added to the list of ignored repositories and will never show in RepoM. +Action to ignore the current repository. This repository will be added to the list of ignored repositories and will never show in RepoM. To undo this action, clear all ignored repositories or manually edit the ignored repositories file (when RepoM is not running). -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -395,13 +395,13 @@ repository-actions: ## pin-repository@1 -Action to pin (or unpin) the current repository. Pinning is not persistant and all pinned repositories will be cleared when RepoM exits. +Action to pin (or unpin) the current repository. Pinning is not persistant and all pinned repositories will be cleared when RepoM exits. Pinning a repository allowed custom filtering, ordering and searching. Action specific properties: - `name`: Name of the action. This is shown in the UI of RepoM. When no value is provided, the name will be a default value based on the mode. (optional, evaluated, string) -- `mode`: The pin mode `[Toggle, Pin, UnPin]`. (required, pinmode) +- `mode`: The pin mode `[Toggle, Pin, UnPin]`. (required, pinmode) Example: @@ -430,9 +430,9 @@ repository-actions: ## separator@1 -Creates a visual separator in the action menu. +Creates a visual separator in the action menu. -This action does not have any specific properties. +This action does not have any specific properties. Example: @@ -454,7 +454,7 @@ repository-actions: These actions are available though the use of plugins. -## clipboard-copy@1 +## clipboard-copy@1 This action makes it possible to copy text to the clipboard. @@ -487,13 +487,13 @@ repository-actions: See the [Clipboard](RepoM.Plugin.Clipboard.md) plugin for more information. -## sonarcloud-set-favorite@1 +## sonarcloud-set-favorite@1 -Action to mark a repository as favorite within SonarCloud. +Action to mark a repository as favorite within SonarCloud. Action specific properties: -- `project`: The SonarCloud project key. (required, evaluated, string) +- `project`: The SonarCloud project key. (required, evaluated, string) Example: @@ -518,9 +518,9 @@ repository-actions: See the [SonarCloud](RepoM.Plugin.SonarCloud.md) plugin for more information. -## azure-devops-create-prs@1 +## azure-devops-create-prs@1 -Action menu item to create a pull request in Azure Devops. +Action menu item to create a pull request in Azure Devops. Action specific properties: @@ -534,7 +534,7 @@ Title will be the last part of the branchname split on `/`, so `feature/123-test - `draft-pr`: Boolean specifying if th PR should be marked as draft. (required, boolean, default: `false`) - `include-work-items`: Boolean specifying if workitems should be included in the PR. The workitems will be found by using the commit messages. (required, boolean, default: `true`) - `open-in-browser`: Boolean specifying if the Pull request should be opened in the browser after creation. (required, boolean, default: `false`) -- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1) +- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1) Example: @@ -585,13 +585,13 @@ repository-actions: ## azure-devops-get-prs@1 -This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser. +This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser. Action specific properties: - `project-id`: The azure devops project id. (required, evaluated, string) - `repository-id`: The repository Id. If not provided, the repository id is located using the remote url. (optional, evaluated, string) -- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`) +- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`) Example: @@ -616,16 +616,16 @@ repository-actions: See the [AzureDevOps](RepoM.Plugin.AzureDevOps.md) plugin for more information. -## heidi-databases@1 +## heidi-databases@1 -Action to list heidi databases and show action menus for them. +Action to list heidi databases and show action menus for them. Action specific properties: - `key`: Repository key. If not provided, the repository `Remote.Origin.Name` is used as selector. (optional, string) -- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string) +- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string) Example: diff --git a/docs/RepoM.Plugin.AzureDevOps.md b/docs/RepoM.Plugin.AzureDevOps.md index 6e52d7dd..985780e4 100644 --- a/docs/RepoM.Plugin.AzureDevOps.md +++ b/docs/RepoM.Plugin.AzureDevOps.md @@ -2,9 +2,9 @@ The AzureDevops module enables integration with one azure devops environment. The integration currently focusses on Pull Requests. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running. @@ -24,11 +24,11 @@ Properties: - `PersonalAccessToken`: Personal access token (PAT) to access Azure Devops. The PAT should be granted access to `todo` rights. To create a PAT, goto `https://dev.azure.com/[my-organisation]/_usersSettings/tokens`. -- `BaseUrl`: The base url of azure devops for your organisation (ie. `https://dev.azure.com/[my-organisation]/`). +- `BaseUrl`: The base url of azure devops for your organisation (ie. `https://dev.azure.com/[my-organisation]/`). -## azure-devops-create-prs@1 +## azure-devops-create-prs@1 -Action menu item to create a pull request in Azure Devops. +Action menu item to create a pull request in Azure Devops. Action specific properties: @@ -42,7 +42,7 @@ Title will be the last part of the branchname split on `/`, so `feature/123-test - `draft-pr`: Boolean specifying if th PR should be marked as draft. (required, boolean, default: `false`) - `include-work-items`: Boolean specifying if workitems should be included in the PR. The workitems will be found by using the commit messages. (required, boolean, default: `true`) - `open-in-browser`: Boolean specifying if the Pull request should be opened in the browser after creation. (required, boolean, default: `false`) -- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1) +- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1) Example: @@ -93,13 +93,13 @@ repository-actions: ## azure-devops-get-prs@1 -This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser. +This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser. Action specific properties: - `project-id`: The azure devops project id. (required, evaluated, string) - `repository-id`: The repository Id. If not provided, the repository id is located using the remote url. (optional, evaluated, string) -- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`) +- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`) Example: diff --git a/docs/RepoM.Plugin.Clipboard.md b/docs/RepoM.Plugin.Clipboard.md index f6a18f0b..6af30063 100644 --- a/docs/RepoM.Plugin.Clipboard.md +++ b/docs/RepoM.Plugin.Clipboard.md @@ -2,13 +2,13 @@ This module provides a repository actions to copy specific (evaluated) text to the clipboard using the action provider type `clipboard-copy`. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration -This module has no configuration. +This module has no configuration. -## clipboard-copy@1 +## clipboard-copy@1 This action makes it possible to copy text to the clipboard. diff --git a/docs/RepoM.Plugin.EverythingFileSearch.md b/docs/RepoM.Plugin.EverythingFileSearch.md index 39e43cdd..cf114d06 100644 --- a/docs/RepoM.Plugin.EverythingFileSearch.md +++ b/docs/RepoM.Plugin.EverythingFileSearch.md @@ -2,8 +2,8 @@ This module integrates with VoidTool Everything in order to locate git repositories on your system. Using Everythings cache, this process will be much faster then locating git repositories the default way. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration -This module has no configuration. +This module has no configuration. diff --git a/docs/RepoM.Plugin.Heidi.md b/docs/RepoM.Plugin.Heidi.md index c212e77b..20d53c6f 100644 --- a/docs/RepoM.Plugin.Heidi.md +++ b/docs/RepoM.Plugin.Heidi.md @@ -2,9 +2,9 @@ *todo description* -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running. @@ -25,18 +25,18 @@ Properties: - `ConfigPath`: The full directory where the configuration is stored. - `ConfigFilename`: The configurration filename (without path) -- `ExecutableFilename`: The full executable of Heidi. +- `ExecutableFilename`: The full executable of Heidi. -## heidi-databases@1 +## heidi-databases@1 -Action to list heidi databases and show action menus for them. +Action to list heidi databases and show action menus for them. Action specific properties: - `key`: Repository key. If not provided, the repository `Remote.Origin.Name` is used as selector. (optional, string) -- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string) +- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string) Example: diff --git a/docs/RepoM.Plugin.LuceneQueryParser.md b/docs/RepoM.Plugin.LuceneQueryParser.md index 2db98493..56713f43 100644 --- a/docs/RepoM.Plugin.LuceneQueryParser.md +++ b/docs/RepoM.Plugin.LuceneQueryParser.md @@ -1,10 +1,10 @@ # Lucene Query Parser -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration -This module has no configuration. +This module has no configuration. To search for repositories, you can use a repom-dialect of Lucene query syntax. diff --git a/docs/RepoM.Plugin.SonarCloud.md b/docs/RepoM.Plugin.SonarCloud.md index 6e5610e8..c3d49718 100644 --- a/docs/RepoM.Plugin.SonarCloud.md +++ b/docs/RepoM.Plugin.SonarCloud.md @@ -2,9 +2,9 @@ This module integrates with SonarCloud. Currently, the only functionality is to star a given repository in SonarCloud using the repository action. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running. @@ -23,15 +23,15 @@ The following default configuration is used: Properties: - `PersonalAccessToken`: Personal Access Token to access SonarCloud. -- `BaseUrl`: SonarCloud url. Most likely `https//sonarcloud.io`. +- `BaseUrl`: SonarCloud url. Most likely `https//sonarcloud.io`. -## sonarcloud-set-favorite@1 +## sonarcloud-set-favorite@1 -Action to mark a repository as favorite within SonarCloud. +Action to mark a repository as favorite within SonarCloud. Action specific properties: -- `project`: The SonarCloud project key. (required, evaluated, string) +- `project`: The SonarCloud project key. (required, evaluated, string) Example: diff --git a/docs/RepoM.Plugin.Statistics.md b/docs/RepoM.Plugin.Statistics.md index a3b8f984..2e22ddf9 100644 --- a/docs/RepoM.Plugin.Statistics.md +++ b/docs/RepoM.Plugin.Statistics.md @@ -2,9 +2,9 @@ This module add functionality to keep track of actions performed on repositories. This can be used in orderings (and mabye later on in filtering) of repositories. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running. @@ -23,4 +23,4 @@ The following default configuration is used: Properties: - `PersistenceBuffer`: Timespan for buffered events before making them persistant (ie. `00:05:00` for five minutes). Must be greater then or equal to `00:00:10` (10 seconds). -- `RetentionDays`: Number of days to keep statical information before deleting them. +- `RetentionDays`: Number of days to keep statical information before deleting them. diff --git a/docs/RepoM.Plugin.WindowsExplorerGitInfo.md b/docs/RepoM.Plugin.WindowsExplorerGitInfo.md index dc8a1ea0..f46d93d3 100644 --- a/docs/RepoM.Plugin.WindowsExplorerGitInfo.md +++ b/docs/RepoM.Plugin.WindowsExplorerGitInfo.md @@ -6,8 +6,8 @@ As an extra goodie for Windows users, RepoM automatically detects open File Expl Note that for Windows 11 users, the title will not be updated but in the taskbar the additional git information is still visible. -To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. +To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. -## Configuration +## Configuration -This module has no configuration. +This module has no configuration.