From 494dfba0b62005d3d86693bce80517daa28f26c1 Mon Sep 17 00:00:00 2001 From: Dennis Ploeger Date: Thu, 18 Apr 2024 08:52:11 +0200 Subject: [PATCH] fix: Remove template from doc generation --- README.md | 15 ++++----------- cmd/doc/mkdoc.go | 3 +++ feature/.template/feature.yaml | 6 +++--- 3 files changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c51ad7b..ce53308 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ Currently supported cloud flavours are: * [Tanzu](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine)) [linux/amd64] Following features and tools are supported: -* ⚙️ Direnv * 🐟 Fish Shell * 📷 AzCopy * 🪪 Certificates @@ -51,7 +50,6 @@ Following features and tools are supported: * [simple](#simple) * [tanzu](#tanzu) * [Features](#features) - * [Direnv](#.template) * [Fish Shell](#_fish) * [AzCopy](#azcopy) * [Certificates](#certificates) @@ -359,15 +357,6 @@ The kubernetes login tokens usually expire after a few hours already. You can ru does. ## Features -### Direnv - -Installs [Direnv](https://direnv.net/) - -#### Configuration - -* USE_.template: Enable this feature -* DEBUG_.template: Debug this feature - ### Fish Shell Installs and configures the [Fish Shell](https://fishshell.com/) with configured [Spacefish theme](https://spacefish.matchai.me/) @@ -820,3 +809,7 @@ flowchart TD click F "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow" click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow" ```mermaid +vops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow" + click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow" +```mermaid +```mermaid diff --git a/cmd/doc/mkdoc.go b/cmd/doc/mkdoc.go index cdc8d98..86cf6c2 100644 --- a/cmd/doc/mkdoc.go +++ b/cmd/doc/mkdoc.go @@ -23,6 +23,9 @@ func fetchDocData(basePath string, filenamePattern string) (map[string]internal. return docDatas, err } else { for _, dir := range subDirs { + if filepath.Base(dir) == ".template" { + continue + } if _, err := os.Stat(filepath.Join(dir, filenamePattern)); err == nil { if yamlFile, err := os.ReadFile(filepath.Join(dir, filenamePattern)); err != nil { return docDatas, err diff --git a/feature/.template/feature.yaml b/feature/.template/feature.yaml index 6c04779..cfc1f24 100644 --- a/feature/.template/feature.yaml +++ b/feature/.template/feature.yaml @@ -2,14 +2,14 @@ # In your new feature, please remove all descriptive comments from the template. # Please use an emoji character as a meaningful logo for your feature -icon: "⚙️" +icon: "🫥" # Set the title for this feature -title: "Direnv" +title: "Template" # Set the description of the feature in Markdown. Be sure to include links to websites of the software the feature # installs or configures -description: "Installs [Direnv](https://direnv.net/)" +description: "Does some awesome stuff" # Use the configuration key to list additional configuration options that you're providing in your feature configuration: