Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
aee86e8
feat (docs): Add auto generation of license and docs
OliverTrautvetter Oct 14, 2025
4b0ba30
fix: prevent new workflow from doing loops and ignoring merges
OliverTrautvetter Oct 14, 2025
f026b7e
auto(docs): update docs and licenses
OliverTrautvetter Oct 14, 2025
3b694fc
fix: amend last commit with auto-generated changes instead of using s…
OliverTrautvetter Oct 14, 2025
630bfdf
fix: amend last commit with auto-generated changes instead of using s…
OliverTrautvetter Oct 14, 2025
6434e76
fix: add signoff to auto-amend commit in update-docs-and-licenses wor…
OliverTrautvetter Oct 14, 2025
f7b9fe7
docs: Describe service root command, update README (#32)
NautiluX Oct 10, 2025
d5c2d20
feat (docs): Add auto generation of license and docs
OliverTrautvetter Oct 14, 2025
86e49c2
fix: prevent new workflow from doing loops and ignoring merges
OliverTrautvetter Oct 14, 2025
c09a065
auto(docs): update docs and licenses
OliverTrautvetter Oct 14, 2025
4a17380
fix: amend last commit with auto-generated changes instead of using s…
OliverTrautvetter Oct 14, 2025
ba8c5c1
fix: add signoff to auto-amend commit in update-docs-and-licenses wor…
OliverTrautvetter Oct 14, 2025
2dec140
Merge branch 'automate_docs_and_license_generation' of https://github…
OliverTrautvetter Oct 14, 2025
5ee6bf2
fix: amend last commit with auto-generated changes instead of using s…
OliverTrautvetter Oct 14, 2025
b3f17bd
Merge branch 'automate_docs_and_license_generation' of https://github…
OliverTrautvetter Oct 14, 2025
df61193
Merge branch 'automate_docs_and_license_generation' of https://github…
OliverTrautvetter Oct 14, 2025
d20d4b3
Merge branch 'automate_docs_and_license_generation' of https://github…
OliverTrautvetter Oct 14, 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
42 changes: 42 additions & 0 deletions .github/workflows/update-docs-and-licenses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

name: 'Auto-Update Docs & Licenses'

permissions:
contents: write

on:
pull_request:
types: [opened, synchronize]
push:
branches:
- main

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 }}
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0

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

- name: Amend last commit with auto-generated changes
run: |
if [ -n "$(git status --porcelain)" ]; then
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git commit --amend --no-edit --signoff
git push --force-with-lease origin ${{ github.event.pull_request.head.ref || github.ref_name }}
fi
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-build1735421141/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-build1735421141/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
21 changes: 21 additions & 0 deletions docs/oms_revoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## oms revoke

Revoke resources available through OMS

### Synopsis

Revoke resources managed by or available for OMS,
eg. api keys.

### Options

```
-h, --help help for revoke
```

### SEE ALSO

* [oms](oms.md) - Codesphere Operations Management System (OMS)
* [oms revoke api-key](oms_revoke_api-key.md) - Revoke an API key

###### Auto generated by spf13/cobra on 14-Oct-2025
24 changes: 24 additions & 0 deletions docs/oms_revoke_api-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## oms revoke api-key

Revoke an API key

### Synopsis

Revoke an OMS portal API key.

```
oms revoke api-key [flags]
```

### Options

```
-h, --help help for api-key
-i, --id string API key id to revoke
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 14-Oct-2025
9 changes: 6 additions & 3 deletions docs/oms_update.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## oms update

Update Codesphere OMS
Update OMS related resources

### Synopsis

Updates the OMS to the latest release from OMS Portal.
Updates resources, e.g. OMS or OMS API keys.

```
oms update [flags]
Expand All @@ -19,5 +19,8 @@ oms update [flags]
### SEE ALSO

* [oms](oms.md) - Codesphere Operations Management System (OMS)
* [oms update api-key](oms_update_api-key.md) - Update an API key's expiration date
* [oms update oms](oms_update_oms.md) - Update the OMS CLI
* [oms update package](oms_update_package.md) - Download a codesphere package

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

Update an API key's expiration date

### Synopsis

Updates the expiration date for a given API key using the --id and --valid-to flags.

```
oms update api-key [flags]
```

### Options

```
-h, --help help for api-key
-i, --id string The ID of the API key to update
-v, --valid-to string The new expiration date in RFC3339 format (e.g., "2025-12-31T23:59:59Z")
```

### SEE ALSO

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

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

Update the OMS CLI

### Synopsis

Updates the OMS CLI to the latest release from OMS Portal.

```
oms update oms [flags]
```

### Options

```
-h, --help help for oms
```

### SEE ALSO

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

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