Workflow to add the output for cds-typer --help in typer section
#1294
Conversation
Co-authored-by: René Jeglinsky <[email protected]>
Co-authored-by: Lothar Bender <[email protected]>
daogrady
requested review from
chgeo,
swaldmann and
renejeglinsky
as code owners
|
This PR made me look for other places where we document the CLI help. There's not a lot but I found that we used specific styling which isn't used here: @chgeo I'm not sure if the green highlighting was how it used to look. Maybe sth has changed? General question: Should add or remove this styling at all places? |
Good catch, I wasn't even aware! A few thoughts on that: If we find that we'd like to have
As this is also the style currently used in the cds-typer section, I guess we can at least postpone the style adjustments? tl;dr: I'd be in favour of dropping the custom style for |
Yes, makes very much sense for me to have other (not necessarily all) commands as well.
Yes, let's handle this separately. |
chgeo
changed the title
cds-typer --help in typer sectioncds-typer --help in typer section
Co-authored-by: Christian Georgi <[email protected]>
Co-authored-by: Christian Georgi <[email protected]>
Co-authored-by: Christian Georgi <[email protected]>
Co-authored-by: Christian Georgi <[email protected]>
|
Let's merge this to see if the workflow worlks. |
|
It failed: https://github.com/cap-js/docs/actions/runs/11128146329/job/30922182608 |
|
Continued in #1301 |
Make #1294 more generic and update more CLI texts. - Use the `<pre class="log">` approach instead of `log` code fence as it allows us to style the output more. - Convert known terminal escape sequences to formats (mainly `<em>`, `<i>`, `<strong>`). - Remove the versions numbers from the output as these would produce diffs for each new version, although the texts have not changed. - Fix the workflow and produce a PR with a stable title. Parallel PRs seem unnecessary. - GH limitation: that PR cannot trigger new workflows. Workaround is to close and reopen the PR. - Example is #1303 This also gets rid of the [custom renovate config to bump inner-md versions](https://github.com/cap-js/docs/blob/810cd2beedab1f0d9aa6ae0777c8b79a69f8f067/.github/renovate.json#L58-L117) and the corresponding PRs. --------- Co-authored-by: Daniel O'Grady <[email protected]>
The documentation for cds-typer contains the output of calling
cds-typer --help. This improves searchability for both search engines and AI. We currently update this part of the docs from time to time, so as of now, the help text could be out of date for some time before being brought up to date.This PR introduces an action that can be triggered manually and automatically runs every Wednesday morning to automatically grab the latest version of the help text. If there are any updates, it will open a PR with the new content.