Updated Wiki Format #3311
Open
Updated Wiki Format #3311
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
…e.g. table format for cli options.
derdanu
requested review from
adreed-msft,
dphulkar-msft,
gapra-msft,
seanmcc-msft,
souravgupta-msft,
tanyasethi-msft,
vibhansa-msft and
wonwuakpa-msft
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new wiki format option to the azcopy doc command, enabling automatic generation of GitHub Wiki-style documentation with improved readability through structured tables for CLI switches and flags.
Key Changes:
- Introduced
--format wikiflag to generate GitHub Wiki-compatible markdown documentation - Implemented table-based format for flags with columns for name, type, default value, and description
- Updated CI workflow to use the new wiki format for automated documentation updates
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| cmd/docWiki.go | New file implementing WikiGenerator with command and flag info extraction, markdown table generation, and template-based rendering |
| cmd/doc.go | Added format flag with "wiki" and "default" options; integrated WikiGenerator for wiki format |
| .github/workflows/update-wiki-docs.yml | Updated to use --format wiki flag in documentation generation step |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
|
|
||
| filename := filepath.Join(g.OutputDir, commandToWikiFilename(cmd)+".md") | ||
| return os.WriteFile(filename, buf.Bytes(), 0644) |
There was a problem hiding this comment.
File permissions 0644 allow world-readable access. Consider using 0600 or 0640 to restrict read access to owner/group only, especially since these files may be written to arbitrary locations specified by user input.
Suggested change
| return os.WriteFile(filename, buf.Bytes(), 0644) | |
| return os.WriteFile(filename, buf.Bytes(), 0600) |
wonwuakpa-msft
approved these changes
Dec 2, 2025
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
New document format for easier readability by creating a table for all CLI switches.
Added the --format wiki option to the doc command to enable automatic wiki generation.
Preview: https://github.com/derdanu/azure-storage-azcopy/wiki/azcopy
Type of Change
Markdown formatter for Github Wiki.
How Has This Been Tested?
./azcopy doc --format wiki
INFO: GitHub Wiki documentation generated in: ./doc