Skip to content

Commit

Permalink
fix: Remove template from doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
dploeger committed Apr 18, 2024
1 parent 119fe2a commit 494dfba
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -359,15 +357,6 @@ The kubernetes login tokens usually expire after a few hours already. You can ru
does.

## Features
### <a id=".template"></a> Direnv

Installs [Direnv](https://direnv.net/)

#### Configuration

* USE_.template: Enable this feature
* DEBUG_.template: Debug this feature

### <a id="_fish"></a> Fish Shell

Installs and configures the [Fish Shell](https://fishshell.com/) with configured [Spacefish theme](https://spacefish.matchai.me/)
Expand Down Expand Up @@ -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
3 changes: 3 additions & 0 deletions cmd/doc/mkdoc.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions feature/.template/feature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 494dfba

Please sign in to comment.