-
Notifications
You must be signed in to change notification settings - Fork 2
feat(docs): Add workflow to automate docs and license generation #38
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.
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
Merged
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 8324c7c
feat: List api key (#30)
OliverTrautvetter 03d4143
feat: Extend api key (#29)
OliverTrautvetter b12a088
docs: Describe service root command, update README (#32)
NautiluX 99a6f9f
feat(docs): Add workflow to automate docs and license generation
OliverTrautvetter 521d4e0
feat(docs): Add workflow to automate docs and license generation
OliverTrautvetter 389ddd1
fix: try to make it less weird
OliverTrautvetter ba1294a
fix: add go to workflow to update license
OliverTrautvetter 16d13cf
chore(docs): Auto-update docs and licenses
github-actions[bot] a512f99
fix: update and simplify workflow for docs and licenses generation
OliverTrautvetter 6920318
fix: maybe fix workflow
OliverTrautvetter 796d99e
chore(docs): Auto-update docs and licenses
OliverTrautvetter 4756e49
chore(docs): Auto-update docs and licenses
OliverTrautvetter 5cd17df
fix: minor change to check workflow trigger
OliverTrautvetter cc204d1
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter d40723a
chore(docs): Auto-update docs and licenses
OliverTrautvetter 26bb384
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter 642cbc1
chore(docs): Auto-update docs and licenses
OliverTrautvetter e3e47e8
fix: prevent temp path in docs
OliverTrautvetter 1c62324
chore(docs): Auto-update docs and licenses
OliverTrautvetter 706ab85
refactor: simplify update-docs-and-licenses script
OliverTrautvetter 6902939
Merge branch 'automate_docs_and_license' of https://github.com/codesp…
OliverTrautvetter 0a1030b
chore(docs): Auto-update docs and licenses
OliverTrautvetter 7a0c95e
ci: ignore and untrack internal util testdata fixtures
OliverTrautvetter 07660bb
ci: keep testdata dir, ignore its contents; add .gitkeep
OliverTrautvetter 67aee9f
fix: update .gitignore to ignore specific testdata file and restore r…
OliverTrautvetter 6806147
fix: update .gitignore to ignore internal util testdata directory and…
OliverTrautvetter 51d0bad
fix: update embed directive to reference specific tar.gz file instead…
OliverTrautvetter 6590378
fix: refactor tar_test to create in-memory tar.gz instead of using em…
OliverTrautvetter a010fc5
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter 6e903c4
chore(docs): Auto-update docs and licenses
OliverTrautvetter 684deab
fix: update main binary name to 'oms-cli' and simplify update script
OliverTrautvetter 349b4fe
chore(docs): Auto-update docs and licenses
OliverTrautvetter c4f4fb8
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter b4032fb
chore(docs): Auto-update docs and licenses
OliverTrautvetter 9930190
fix: improve command example formatting and ensure stable binary name…
OliverTrautvetter 89d0c08
fix: update command name in documentation generation to ensure consis…
OliverTrautvetter 5edc3a9
chore(docs): Auto-update docs and licenses
OliverTrautvetter a9c9bd9
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter fbd851c
chore(docs): Auto-update docs and licenses
OliverTrautvetter c177147
fix: update logging method in WriteCounter to ensure progress message…
OliverTrautvetter 7d04c75
fix: handle error when logging progress in WriteCounter
OliverTrautvetter 0cb1759
fix: remove unnecessary directory change in update-docs-and-licenses …
OliverTrautvetter 356a167
fix: update documentation generation to use oms-cli.md for README
OliverTrautvetter 7d16506
chore(docs): Auto-update docs and licenses
OliverTrautvetter 401c180
Merge branch 'main' into automate_docs_and_license
OliverTrautvetter 1a48a9d
chore(docs): Auto-update docs and licenses
OliverTrautvetter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 }} | ||
OliverTrautvetter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - 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' | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.