Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add variable for custom wiki directory separator #90

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

virgofx
Copy link
Member

@virgofx virgofx commented Oct 26, 2024

Pull Request Description

Summary

This pull request introduces several enhancements and improvements to the wiki generation process. The key changes include:

  • Quality Gate Badge: Added a quality gate badge to the README for improved visibility of the project’s quality metrics.

  • Constants for Wiki Titles: Introduced additional constants for handling wiki title replacements. This ensures that slashes and hyphens are displayed correctly in the generated wiki pages.

  • Directory Cleanup: Implemented the removeDirectoryContents function in the file-utils module. This function clears the directory before generating wiki content, ensuring that all files are correctly generated and preventing stale data from remaining.

  • Refactoring in wiki.ts:

    1. Split the wiki generation process and the commit/push operations into distinct functions for better clarity and separation of concerns.
    2. Removed the unnecessary wiki_subdirectory (e.g., generated) folder to streamline the structure.
    3. Ensured comprehensive generation of all necessary wiki files, leading to a more complete and functional output.

Related Issues

@virgofx virgofx self-assigned this Oct 26, 2024
@virgofx virgofx added the enhancement New feature or request label Oct 26, 2024
@virgofx virgofx force-pushed the 80-flatten-nested-folder-modules-for-wiki branch 18 times, most recently from e5f12f2 to 891a713 Compare October 27, 2024 22:46
- Added quality gate badge to README for better visibility.
- Introduced additional constants for wiki title replacements to ensure
  slashes and hyphens are displayed correctly.
- Implemented `removeDirectoryContents` in file-utils to clear the
  directory before generating wiki content, ensuring 100% of the files
  are present.
- Refactored wiki.ts:
  1. Split wiki generation and commit/push into distinct functions.
  2. Removed unnecessary wiki_subdirectory (e.g., generated) folder.
  3. Ensured comprehensive generation of the wiki files.

Fixes #80
@virgofx virgofx force-pushed the 80-flatten-nested-folder-modules-for-wiki branch from 891a713 to 260b9d1 Compare October 27, 2024 23:18
Copy link

Copy link

Release Plan

No terraform modules updated in this pull request.

✅ Wiki Check ℹ️

Note: The following Terraform modules no longer exist in source; however, corresponding tags/releases exist. Automation tag/release deletion is disabledno subsequent action will take place.

v1.2.0, v1.1.1, v1.1.0, v1.0.1, v1.0.0, v1

Powered by techpivot/terraform-module-releaser

@virgofx virgofx merged commit ec8ca75 into main Oct 27, 2024
7 checks passed
@virgofx virgofx deleted the 80-flatten-nested-folder-modules-for-wiki branch October 27, 2024 23:21
@release-preview release-preview bot mentioned this pull request Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flatten Nested Folder Modules for Wiki
1 participant