feat: add useSSHSourceFormat option to configure source URL format in Wiki documentation #146
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
virgofx
force-pushed
the
136-allow-customizing-the-source-string-generated-in-the-wiki
branch
7 times, most recently
from
1a3cbf2 to
e0d88c8
Compare
This was referenced Feb 7, 2025
virgofx
force-pushed
the
136-allow-customizing-the-source-string-generated-in-the-wiki
branch
from
e0d88c8 to
cb4f505
Compare
… Wiki documentation
virgofx
force-pushed
the
136-allow-customizing-the-source-string-generated-in-the-wiki
branch
from
cb4f505 to
4047b8b
Compare
Release PlanNo terraform modules updated in this pull request.
Powered by
|
|
virgofx
deleted the
136-allow-customizing-the-source-string-generated-in-the-wiki
branch
Merged
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.
This pull request introduces a new configuration option to use SSH format for source links in generated Wiki documentation, along with several related updates across the codebase. Here are the most important changes:
Configuration Updates:
use-ssh-source-formatoption to the configuration, allowing users to choose between SSH and HTTPS formats for source links in Wiki documentation (.github/workflows/ci.yml,action.yml,src/types/index.ts,src/config.ts). [1] [2] [3] [4]Documentation and Workflow Changes:
README.mdto include the newuse-ssh-source-formatparameter and its description. [1] [2].github/workflows/test.ymlto useSonarQube Scaninstead ofSonarCloud Scan.Code and Test Updates:
__mocks__/config.tsand__tests__/config.test.tsto support and test the newuse-ssh-source-formatconfiguration option. [1] [2] [3]__tests__/wiki.test.tsto ensure correct formatting of source URLs based on theuseSSHSourceFormatsetting.Implementation Details:
formatModuleSourcefunction insrc/wiki.tsto format source URLs based on the new configuration setting. [1] [2]These changes collectively enhance the flexibility and configurability of the module by allowing users to specify their preferred source URL format in the generated Wiki documentation.
Fixes #136