Skip to content

Commit

Permalink
Merge branch 'feature/update-docs' of https://github.com/coenm/RepoM
Browse files Browse the repository at this point in the history
…into feature/update-docs
  • Loading branch information
coenm committed Sep 9, 2024
2 parents 58b7a29 + a49b022 commit 78dcfe3
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 8 deletions.
6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.azuredevops.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

The AzureDevops module enables integration with one azure devops environment. The integration currently focuses 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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.AzureDevOps
- PluginName: AzureDevOps
- PluginDescription: Integration with Azure Devops providing fetching and creating pull requests.
- PluginMarkdownDescription: The AzureDevops module enables integration with one azure devops environment. The integration currently focuses on Pull Requests.

## Configuration

The configuration. TODO

This module contains the following methods, variables and/or constants:

## azure-devops-create-pr@1
Expand Down
6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.clipboard.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.Clipboard
- PluginName: Clipboard
- PluginDescription: Provides a 'copy to clipboard' action.
- PluginMarkdownDescription: This module provides a repository actions to copy specific (evaluated) text to the clipboard using the action provider type `clipboard-copy`.

## Configuration

This plugin has no configuration.

This module contains the following methods, variables and/or constants:

## clipboard-copy@1
Expand Down
6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.heidi.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

This module integrates with a portable [HeidiSQL](https://www.heidisql.com/) installation. The portable Heidi DB saves its database configuration in a portable configuration file. This module monitors this file and makes it possible to use this configuration in the action menu.

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.Heidi
- PluginName: HeidiSQL
- PluginDescription: Contains context variables to be used in the action menu. The variables are extracted from the portable Heidi DB configuration.
- PluginMarkdownDescription: This module integrates with a portable [HeidiSQL](https://www.heidisql.com/) installation. The portable Heidi DB saves its database configuration in a portable configuration file. This module monitors this file and makes it possible to use this configuration in the action menu.

## Configuration

The configuration. TODO

6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.lucenequeryparser.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Contains a custom query parser based on Lucene syntax for repository filtering.

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.LuceneQueryParser
- PluginName: LuceneQueryParser
- PluginDescription: Contains a custom query parser based on Lucene syntax for repository filtering.
- PluginMarkdownDescription: \<empty\>

## Configuration

This plugin has no configuration.

6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.sonarcloud.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.SonarCloud
- PluginName: SonarCloud
- PluginDescription: Providing a repository action to mark a repository as favorite in SonarCloud
- PluginMarkdownDescription: This module integrates with SonarCloud. Currently, the only functionality is to star a given repository in SonarCloud using the repository action.

## Configuration

The configuration. TODO

This module contains the following methods, variables and/or constants:

## sonarcloud-set-favorite@1
Expand Down
6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.statistics.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Provides functionality to keep track how may times an action is performed on a given repository. These numbers can be accessed using variable providers. The plugin also contains functionality to use these statistics in orderings.

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.Statistics
- PluginName: Statistics
- PluginDescription: Provides functionality to keep track how may times an action is performed on a given repository. These numbers can be accessed using variable providers. The plugin also contains functionality to use these statistics in orderings.
- PluginMarkdownDescription: \<empty\>

## Configuration

The configuration. TODO

6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.webbrowser.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

Provides functionality to start a web browser from an action with profile information.

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.WebBrowser
- PluginName: WebBrowser
- PluginDescription: Provides functionality to start a web browser from an action with profile information.
- PluginMarkdownDescription: \<empty\>

## Configuration

The configuration. TODO

This module contains the following methods, variables and/or constants:

## browser@1
Expand Down
6 changes: 5 additions & 1 deletion docs/plugin_repom.plugin.windowsexplorergitinfo.generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

As an extra goodie for Windows users, RepoM automatically detects open File Explorer windows and adds a status appendix to their title if they are in context of a git repository.

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'. After enabling or disabling a plugin, you should restart RepoM.

- ProjectName: RepoM.Plugin.WindowsExplorerGitInfo
- PluginName: WindowsExplorerTitle
- PluginDescription: Contains a hook updating Explorer views in Windows with the current git status.
- PluginMarkdownDescription: As an extra goodie for Windows users, RepoM automatically detects open File Explorer windows and adds a status appendix to their title if they are in context of a git repository.

## Configuration

This plugin has no configuration.

4 changes: 4 additions & 0 deletions docs/repom.generated.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# RepoM Core Repository Actions

## Configuration

This plugin has no configuration.

This module contains the following methods, variables and/or constants:

## browse-repository@1
Expand Down

0 comments on commit 78dcfe3

Please sign in to comment.