question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

When a change occurs in che-server file `che.properties`, generate equivalent docs in che-docs

See original GitHub issue

Is your task related to a problem? Please describe.

In che-docs, we generate some part of the documentation based on che.properties, using the tools/environment_docs_gen.sh.

As there is no automation / release management around that process:

  • A human runs the script manually and raise a PR when he knows some change happened.
  • As the generated docs always lags behind, the script is also run at build and publication time (but not commited back).

Describe the solution you’d like

We would like that a change of che.properties in a given branch of the che repository triggers an update in the according branch of the che-docs repository.

Example:

  • File is changed in the branch 7.26.x of the che repository => run tools/environment_docs_gen.sh in the branch 7.26.x of the che-docs repository.

  • File is changed in the branch main/master of the che repository => run tools/environment_docs_gen.sh in the branch main/master of the che-docs repository.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
nickboldtcommented, Sep 28, 2021

So I’m hearing:

on push of change to https://github.com/eclipse-che/che-server/blob/main/assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties in any .x or master/main branch:

  • trigger workflow in che-docs repo with single parameter “branch” = same branch affected in eclipse/che repo

This means we need:

  • a workflow action in eclipse/che-docs which generates a PR that can be reviewed by 2 people and approved
  • an on-push action in eclipse/che which does API call to workflow action in eclipse/che-docs
0reactions
mkuznyetsovcommented, Nov 4, 2021

closing, as It has been tested, and seems to work now

Read more comments on GitHub >

github_iconTop Results From Across the Web

Introduction to Eclipse Che :: Eclipse Che Documentation
Che defines the workspace to be the project code files and all the dependencies necessary to edit, build, run, and debug them. Che...
Read more >
Eclipse Che documentation project - GitHub
This repository contains sources for the documentation for Eclipse Che. To contribute to the documentation, see the Contribution guide. We love pull requests ......
Read more >
Administration Guide Red Hat CodeReady Workspaces 1.0
Workspaces are defined as project code files and all of their dependencies neccessary to edit, build, run, and debug them. Each workspace has...
Read more >
v1 - Go Packages
See the following page: https://www.eclipse.org/che/docs/stable/ ... further configure how the Operator and the Che server make that happen on Kubernetes.
Read more >
Delft Students on Software Architecture – DESOSA 2019
Every version of Arduino is found to be similar due to the commonality factor ... Server infrastructures are used to make environments for...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found