Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
87cb75f
feat: Extend baseimage (#25)
NautiluX Oct 9, 2025
8324c7c
feat: List api key (#30)
OliverTrautvetter Oct 10, 2025
03d4143
feat: Extend api key (#29)
OliverTrautvetter Oct 10, 2025
b12a088
docs: Describe service root command, update README (#32)
NautiluX Oct 10, 2025
99a6f9f
feat(docs): Add workflow to automate docs and license generation
OliverTrautvetter Oct 14, 2025
521d4e0
feat(docs): Add workflow to automate docs and license generation
OliverTrautvetter Oct 14, 2025
389ddd1
fix: try to make it less weird
OliverTrautvetter Oct 14, 2025
ba1294a
fix: add go to workflow to update license
OliverTrautvetter Oct 14, 2025
16d13cf
chore(docs): Auto-update docs and licenses
github-actions[bot] Oct 14, 2025
a512f99
fix: update and simplify workflow for docs and licenses generation
OliverTrautvetter Oct 14, 2025
6920318
fix: maybe fix workflow
OliverTrautvetter Oct 14, 2025
796d99e
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 14, 2025
4756e49
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 14, 2025
5cd17df
fix: minor change to check workflow trigger
OliverTrautvetter Oct 14, 2025
cc204d1
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 14, 2025
d40723a
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 14, 2025
26bb384
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 15, 2025
642cbc1
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 15, 2025
e3e47e8
fix: prevent temp path in docs
OliverTrautvetter Oct 16, 2025
1c62324
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 16, 2025
706ab85
refactor: simplify update-docs-and-licenses script
OliverTrautvetter Oct 16, 2025
6902939
Merge branch 'automate_docs_and_license' of https://github.com/codesp…
OliverTrautvetter Oct 16, 2025
0a1030b
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 16, 2025
7a0c95e
ci: ignore and untrack internal util testdata fixtures
OliverTrautvetter Oct 16, 2025
07660bb
ci: keep testdata dir, ignore its contents; add .gitkeep
OliverTrautvetter Oct 16, 2025
67aee9f
fix: update .gitignore to ignore specific testdata file and restore r…
OliverTrautvetter Oct 16, 2025
6806147
fix: update .gitignore to ignore internal util testdata directory and…
OliverTrautvetter Oct 16, 2025
51d0bad
fix: update embed directive to reference specific tar.gz file instead…
OliverTrautvetter Oct 16, 2025
6590378
fix: refactor tar_test to create in-memory tar.gz instead of using em…
OliverTrautvetter Oct 16, 2025
a010fc5
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 16, 2025
6e903c4
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 16, 2025
684deab
fix: update main binary name to 'oms-cli' and simplify update script
OliverTrautvetter Oct 17, 2025
349b4fe
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 17, 2025
c4f4fb8
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 17, 2025
b4032fb
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 17, 2025
9930190
fix: improve command example formatting and ensure stable binary name…
OliverTrautvetter Oct 17, 2025
89d0c08
fix: update command name in documentation generation to ensure consis…
OliverTrautvetter Oct 17, 2025
5edc3a9
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 17, 2025
a9c9bd9
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 23, 2025
fbd851c
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 23, 2025
c177147
fix: update logging method in WriteCounter to ensure progress message…
OliverTrautvetter Oct 23, 2025
7d04c75
fix: handle error when logging progress in WriteCounter
OliverTrautvetter Oct 23, 2025
0cb1759
fix: remove unnecessary directory change in update-docs-and-licenses …
OliverTrautvetter Oct 23, 2025
356a167
fix: update documentation generation to use oms-cli.md for README
OliverTrautvetter Oct 23, 2025
7d16506
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 23, 2025
401c180
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter Oct 23, 2025
1a48a9d
chore(docs): Auto-update docs and licenses
OliverTrautvetter Oct 23, 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: 3 additions & 0 deletions .github/workflows/cli-build_test.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

# This workflow will build a golang project
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/go-lint.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

name: golangci-lint
on:
push:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/service-build_test.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

# This workflow will build a golang project
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/tag-release.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

name: Tag

on:
Expand Down
45 changes: 45 additions & 0 deletions .github/workflows/update-docs-and-licenses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

name: 'Auto-Update Docs & Licenses'

permissions:
contents: write

on:
pull_request:
types: [opened, synchronize]

jobs:
update-files:
# skip runs triggered by the bot's own commit to avoid loops
if: github.actor != 'github-actions[bot]'
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4
with:
# on push to main, use main; on PR, check out the PR head
ref: ${{ github.event.pull_request.head.ref || github.ref }}

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: '1.24.2'

- name: Update docs & licenses
run: |
./hack/update-docs-and-licenses.sh

- name: Commit and push auto-generated changes
uses: EndBug/add-and-commit@v9
with:
# Use the PR author's identity for the commit
author_name: ${{ github.event.pull_request.user.login }}
author_email: ${{ github.event.pull_request.user.id }}+${{ github.event.pull_request.user.login }}@users.noreply.github.com

# Commit message
message: 'chore(docs): Auto-update docs and licenses'

# Adds a sign-off to the commit message for DCO
commit: '--signoff'
48 changes: 24 additions & 24 deletions NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,23 @@ Version: v3.5.1
License: MIT
License URL: https://github.com/blang/semver/blob/v3.5.1/LICENSE

----------
Module: github.com/clipperhouse/uax29/v2
Version: v2.2.0
License: MIT
License URL: https://github.com/clipperhouse/uax29/blob/v2.2.0/LICENSE

----------
Module: github.com/codesphere-cloud/cs-go/pkg/io
Version: v0.10.1
Version: v0.11.1
License: Apache-2.0
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.10.1/LICENSE
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.11.1/LICENSE

----------
Module: github.com/cpuguy83/go-md2man/v2/md2man
Version: v2.0.6
Version: v2.0.7
License: MIT
License URL: https://github.com/cpuguy83/go-md2man/blob/v2.0.6/LICENSE.md
License URL: https://github.com/cpuguy83/go-md2man/blob/v2.0.7/LICENSE.md

----------
Module: github.com/davecgh/go-spew/spew
Expand Down Expand Up @@ -47,28 +53,22 @@ License URL: https://github.com/inconshreveable/go-update/blob/8152e7eb6ccf/inte

----------
Module: github.com/jedib0t/go-pretty/v6
Version: v6.6.7
Version: v6.6.8
License: MIT
License URL: https://github.com/jedib0t/go-pretty/blob/v6.6.7/LICENSE
License URL: https://github.com/jedib0t/go-pretty/blob/v6.6.8/LICENSE

----------
Module: github.com/mattn/go-runewidth
Version: v0.0.16
Version: v0.0.19
License: MIT
License URL: https://github.com/mattn/go-runewidth/blob/v0.0.16/LICENSE
License URL: https://github.com/mattn/go-runewidth/blob/v0.0.19/LICENSE

----------
Module: github.com/pmezard/go-difflib/difflib
Version: v1.0.1-0.20181226105442-5d4384ee4fb2
License: BSD-3-Clause
License URL: https://github.com/pmezard/go-difflib/blob/5d4384ee4fb2/LICENSE

----------
Module: github.com/rivo/uniseg
Version: v0.4.7
License: MIT
License URL: https://github.com/rivo/uniseg/blob/v0.4.7/LICENSE.txt

----------
Module: github.com/russross/blackfriday/v2
Version: v2.1.0
Expand All @@ -77,15 +77,15 @@ License URL: https://github.com/russross/blackfriday/blob/v2.1.0/LICENSE.txt

----------
Module: github.com/spf13/cobra
Version: v1.9.1
Version: v1.10.1
License: Apache-2.0
License URL: https://github.com/spf13/cobra/blob/v1.9.1/LICENSE.txt
License URL: https://github.com/spf13/cobra/blob/v1.10.1/LICENSE.txt

----------
Module: github.com/spf13/pflag
Version: v1.0.6
Version: v1.0.10
License: BSD-3-Clause
License URL: https://github.com/spf13/pflag/blob/v1.0.6/LICENSE
License URL: https://github.com/spf13/pflag/blob/v1.0.10/LICENSE

----------
Module: github.com/stretchr/objx
Expand All @@ -95,21 +95,21 @@ License URL: https://github.com/stretchr/objx/blob/v0.5.2/LICENSE

----------
Module: github.com/stretchr/testify
Version: v1.10.0
Version: v1.11.1
License: MIT
License URL: https://github.com/stretchr/testify/blob/v1.10.0/LICENSE
License URL: https://github.com/stretchr/testify/blob/v1.11.1/LICENSE

----------
Module: golang.org/x/sync/errgroup
Version: v0.16.0
Version: v0.17.0
License: BSD-3-Clause
License URL: https://cs.opensource.google/go/x/sync/+/v0.16.0:LICENSE
License URL: https://cs.opensource.google/go/x/sync/+/v0.17.0:LICENSE

----------
Module: golang.org/x/text
Version: v0.28.0
Version: v0.29.0
License: BSD-3-Clause
License URL: https://cs.opensource.google/go/x/text/+/v0.28.0:LICENSE
License URL: https://cs.opensource.google/go/x/text/+/v0.29.0:LICENSE

----------
Module: gopkg.in/yaml.v3
Expand Down
Binary file modified cli/cmd/testdata/testcli.tar.gz
Binary file not shown.
7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ like downloading new versions.

### SEE ALSO

* [oms beta](oms_beta.md) - Commands for early testing
* [oms download](oms_download.md) - Download resources available through OMS
* [oms list](oms_list.md) - List resources available through OMS
* [oms update](oms_update.md) - Update Codesphere OMS
* [oms register](oms_register.md) - Register a new API key
* [oms revoke](oms_revoke.md) - Revoke resources available through OMS
* [oms update](oms_update.md) - Update OMS related resources
* [oms version](oms_version.md) - Print version

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
7 changes: 5 additions & 2 deletions docs/oms.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ like downloading new versions.

### SEE ALSO

* [oms beta](oms_beta.md) - Commands for early testing
* [oms download](oms_download.md) - Download resources available through OMS
* [oms list](oms_list.md) - List resources available through OMS
* [oms update](oms_update.md) - Update Codesphere OMS
* [oms register](oms_register.md) - Register a new API key
* [oms revoke](oms_revoke.md) - Revoke resources available through OMS
* [oms update](oms_update.md) - Update OMS related resources
* [oms version](oms_version.md) - Print version

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
21 changes: 21 additions & 0 deletions docs/oms_beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## oms beta

Commands for early testing

### Synopsis

OMS CLI commands for early adoption and testing.
Be aware that that usage and behavior may change as the features are developed.

### Options

```
-h, --help help for beta
```

### SEE ALSO

* [oms](oms.md) - Codesphere Operations Management System (OMS)
* [oms beta extend](oms_beta_extend.md) - Extend Codesphere ressources such as base images.

###### Auto generated by spf13/cobra on 14-Oct-2025
20 changes: 20 additions & 0 deletions docs/oms_beta_extend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## oms beta extend

Extend Codesphere ressources such as base images.

### Synopsis

Extend Codesphere ressources such as base images to customize them for your needs.

### Options

```
-h, --help help for extend
```

### SEE ALSO

* [oms beta](oms_beta.md) - Commands for early testing
* [oms beta extend baseimage](oms_beta_extend_baseimage.md) - Extend Codesphere's workspace base image for customization

###### Auto generated by spf13/cobra on 14-Oct-2025
30 changes: 30 additions & 0 deletions docs/oms_beta_extend_baseimage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## oms beta extend baseimage

Extend Codesphere's workspace base image for customization

### Synopsis

Loads the baseimage from Codesphere package and generates a Dockerfile based on it.
This enables you to extend Codesphere's base image with specific dependencies.

To use the custom base image, you need to push the resulting image to your container registry and
reference it in your install-config for the Codesphere installation process to pick it up and include it in Codesphere

```
oms beta extend baseimage [flags]
```

### Options

```
-d, --dockerfile string Output Dockerfile to generate for extending the base image (default "Dockerfile")
-f, --force Enforce package extraction
-h, --help help for baseimage
-p, --package string Package file (e.g. codesphere-v1.2.3-installer.tar.gz) to load base image from
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 14-Oct-2025
6 changes: 1 addition & 5 deletions docs/oms_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ Download resources available through OMS
Download resources managed by or available for OMS,
e.g. available Codesphere packages

```
oms download [flags]
```

### Options

```
Expand All @@ -22,4 +18,4 @@ oms download [flags]
* [oms](oms.md) - Codesphere Operations Management System (OMS)
* [oms download package](oms_download_package.md) - Download a codesphere package

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
6 changes: 3 additions & 3 deletions docs/oms_download_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ oms download package [flags]

```
# Download Codesphere version 1.55.0
$ /var/folders/h2/qdn9mcsx32j2384qdrqyqlkw0000gn/T/go-build3505592854/b001/exe/main download package --version 1.55.0
$ /tmp/go-build3887606042/b001/exe/main download package --version codesphere-v1.55.0

# Download lite package of Codesphere version 1.55.0
$ /var/folders/h2/qdn9mcsx32j2384qdrqyqlkw0000gn/T/go-build3505592854/b001/exe/main download package --version 1.55.0 --file installer-lite.tar.gz
$ /tmp/go-build3887606042/b001/exe/main download package --version codesphere-v1.55.0 --file installer-lite.tar.gz
```

### Options
Expand All @@ -34,4 +34,4 @@ $ /var/folders/h2/qdn9mcsx32j2384qdrqyqlkw0000gn/T/go-build3505592854/b001/exe/m

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

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
3 changes: 2 additions & 1 deletion docs/oms_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ eg. available Codesphere packages
### SEE ALSO

* [oms](oms.md) - Codesphere Operations Management System (OMS)
* [oms list api-keys](oms_list_api-keys.md) - List API keys
* [oms list packages](oms_list_packages.md) - List available packages

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
23 changes: 23 additions & 0 deletions docs/oms_list_api-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## oms list api-keys

List API keys

### Synopsis

List API keys registered in the OMS portal.

```
oms list api-keys [flags]
```

### Options

```
-h, --help help for api-keys
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 14-Oct-2025
2 changes: 1 addition & 1 deletion docs/oms_list_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ oms list packages [flags]

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

###### Auto generated by spf13/cobra on 19-Sep-2025
###### Auto generated by spf13/cobra on 14-Oct-2025
27 changes: 27 additions & 0 deletions docs/oms_register.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## oms register

Register a new API key

### Synopsis

Register a new API key for accessing the OMS portal.

```
oms register [flags]
```

### Options

```
-e, --expires string Expiration date of the new API key. Default is 1 year from now. Format: RFC3339 (e.g., 2024-12-31T23:59:59Z)
-h, --help help for register
-g, --organization string Organization of the new API key
-o, --owner string Owner of the new API key
-r, --role string Role of the new API key. Available roles: Admin, Dev, Ext (default "Ext")
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 14-Oct-2025
Loading