Skip to content

Remove date metadata in auto-generated documentation #65

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.

Sign up for GitHub

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

Merged
OliverTrautvetter merged 7 commits into from
Nov 10, 2025
Merged

Remove date metadata in auto-generated documentation #65

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d5aa690
fix: update documentation generation to have less spam
OliverTrautvetter Oct 30, 2025
cc60d9e
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 30, 2025
af6f420
ref: remove date from readme
OliverTrautvetter Nov 5, 2025
91c2909
Merge branch 'no_date_in_docs' of https://github.com/codesphere-cloud…
OliverTrautvetter Nov 5, 2025
f71cf50
fix: copy oms-cli.md to README.md during docs generation
OliverTrautvetter Nov 10, 2025
c0fa2a4
Merge branch 'main' into no_date_in_docs
OliverTrautvetter Nov 10, 2025
0e202d4
chore(docs): Auto-update docs and licenses
OliverTrautvetter Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ release-local: install-build-deps
docs:
rm -rf docs
mkdir docs
go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms-cli'" hack/gendocs/main.go
cp docs/oms-cli.md docs/README.md
go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms-cli'" hack/gendocs/main.go

generate-license: generate
go-licenses report --template .NOTICE.template ./... > NOTICE
Expand Down
3 changes: 1 addition & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,4 @@ like downloading new versions.
* [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS
* [oms-cli update](oms-cli_update.md) - Update OMS related resources
* [oms-cli version](oms-cli_version.md) - Print version

###### Auto generated by spf13/cobra on 23-Oct-2025
###### Auto generated by spf13/cobra on 30-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ like downloading new versions.
* [oms-cli update](oms-cli_update.md) - Update OMS related resources
* [oms-cli version](oms-cli_version.md) - Print version

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_beta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ Be aware that that usage and behavior may change as the features are developed.
* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)
* [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images.

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_beta_extend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ Extend Codesphere ressources such as base images to customize them for your need
* [oms-cli beta](oms-cli_beta.md) - Commands for early testing
* [oms-cli beta extend baseimage](oms-cli_beta_extend_baseimage.md) - Extend Codesphere's workspace base image for customization

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_beta_extend_baseimage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ oms-cli beta extend baseimage [flags]

* [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images.

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ e.g. available Codesphere packages
* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)
* [oms-cli download package](oms-cli_download_package.md) - Download a codesphere package

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_download_package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta

* [oms-cli download](oms-cli_download.md) - Download resources available through OMS

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ Coming soon: Install Codesphere and other components like Ceph and PostgreSQL.
* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)
* [oms-cli install codesphere](oms-cli_install_codesphere.md) - Install a Codesphere instance

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_install_codesphere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@ oms-cli install codesphere [flags]

* [oms-cli install](oms-cli_install.md) - Coming soon: Install Codesphere and other components

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_licenses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ oms-cli licenses [flags]

* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ eg. available Codesphere packages
* [oms-cli list api-keys](oms-cli_list_api-keys.md) - List API keys
* [oms-cli list packages](oms-cli_list_packages.md) - List available packages

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_list_api-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ oms-cli list api-keys [flags]

* [oms-cli list](oms-cli_list.md) - List resources available through OMS

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_list_packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ oms-cli list packages [flags]

* [oms-cli list](oms-cli_list.md) - List resources available through OMS

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_register.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ oms-cli register [flags]

* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_revoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ eg. api keys.
* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)
* [oms-cli revoke api-key](oms-cli_revoke_api-key.md) - Revoke an API key

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_revoke_api-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ oms-cli revoke api-key [flags]

* [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ oms-cli update [flags]
* [oms-cli update oms](oms-cli_update_oms.md) - Update the OMS CLI
* [oms-cli update package](oms-cli_update_package.md) - Download a codesphere package

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_update_api-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@ oms-cli update api-key [flags]

* [oms-cli update](oms-cli_update.md) - Update OMS related resources

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_update_oms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ oms-cli update oms [flags]

* [oms-cli update](oms-cli_update.md) - Update OMS related resources

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_update_package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta

* [oms-cli update](oms-cli_update.md) - Update OMS related resources

###### Auto generated by spf13/cobra on 23-Oct-2025
1 change: 0 additions & 1 deletion docs/oms-cli_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ oms-cli version [flags]

* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS)

###### Auto generated by spf13/cobra on 23-Oct-2025
28 changes: 27 additions & 1 deletion hack/gendocs/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
package main

import (
"fmt"
"log"
"os"
"strings"
"time"

oms "github.com/codesphere-cloud/oms/cli/cmd"
"github.com/spf13/cobra/doc"
Expand All @@ -15,7 +19,29 @@ func main() {
root := oms.GetRootCmd()
root.Use = "oms-cli"

err := doc.GenMarkdownTree(root, "docs")
root.DisableAutoGenTag = true

identity := func(s string) string { return s }
emptyStr := func(s string) string { return "" }
now := time.Now().Format("2-Jan-2006")
err := doc.GenMarkdownTreeCustom(root, "docs", emptyStr, identity)
if err != nil {
log.Fatal(err)
}

mainDocPath := "docs/oms-cli.md"
readmePath := "docs/README.md"

content, err := os.ReadFile(mainDocPath)
if err != nil {
log.Fatal(err)
}

contentStr := strings.TrimRight(string(content), "\n")
timestampLine := fmt.Sprintf("\n###### Auto generated by spf13/cobra on %s\n", now)
contentWithTimestamp := contentStr + timestampLine

err = os.WriteFile(readmePath, []byte(contentWithTimestamp), 0644)
if err != nil {
log.Fatal(err)
}
Expand Down