eclipse-orbit / .eclipsefdn

Repository to host configurations related to the Eclipse Foundation.
https://eclipse-orbit.github.io/.eclipsefdn/
0 stars 2 forks source link

Provide better descriptions for the repositories #3

Closed merks closed 1 year ago

github-actions[bot] commented 1 year ago
Diff for 7918c2fa90b2525644253e5f641a151f44a99a60: ```diff Printing local diff for configuration at '/home/runner/work/.eclipsefdn/.eclipsefdn/otterdog-configs/otterdog.json' Actions are indicated with the following symbols: + create ! modify ! forced update - delete Organization eclipse-orbit[id=eclipse-orbit] ! repository[name="ebr"] { ! description = "Eclipse bundle recipes" -> "Eclipse Bundle Recipe infrastructure." } ! repository[name="orbit"] { ! description = "None" -> "Third-party libraries bundled using Eclipse Bundle Recipes." } Plan: 0 to add, 2 to change, 0 to delete. ``` ```diff Showing diff to a canonical version of the configuration at '/home/runner/work/.eclipsefdn/.eclipsefdn/otterdog-configs/otterdog.json' Organization eclipse-orbit[id=eclipse-orbit] ```
netomi commented 1 year ago

change applied.

merks commented 1 year ago

I really feel way more empowered with this new approach!

netomi commented 1 year ago

We are happy that project members are starting to use and like the approach. It certainly feels natural for somebody writing code to also request configuration changes that way.

There are a couple of things that we would like to add: https://gitlab.eclipse.org/eclipsefdn/security/otterdog You can also suggest features or changes yourself.

Currently, we also work on providing a more details documentation of the tool and the way to configure stuff, the latest version can be accessed at https://otterdog.readthedocs.io/en/latest/

merks commented 1 year ago

It's great. Of course better documentation will be a good thing, i.e., all the properties one can use to configure things...

netomi commented 1 year ago

All supported settings should be listed here: https://gitlab.eclipse.org/eclipsefdn/security/otterdog#supported-settings To know what value is defined for each setting in the default config, you can take a look here: https://github.com/EclipseFdn/otterdog-defaults/blob/main/otterdog-defaults.libsonnet

Its not very user friendly, we are on it to improve the documentation at http://otterdog.readthedocs.io

merks commented 1 year ago

Silly/stupid me! I am on my small laptop monitor and I did not scroll far enough to notice the extensive README.md. 😜

merks commented 1 year ago

BTW, I was reviewing the settings and then when I look at Oomph's configuration, I'm not sure why this repo has discussions:

https://github.com/eclipse-oomph/oomph

but this one does not:

https://github.com/eclipse-oomph/oomph.incubator

yet the settings look the same:

    orgs.newRepo('oomph') {
      allow_update_branch: false,
      default_branch: "master",
      web_commit_signoff_required: false,
    },
    orgs.newRepo('oomph.incubator') {
      allow_update_branch: false,
      default_branch: "master",
      web_commit_signoff_required: false,
    },

Maybe a missing or undocumented configuration property?

netomi commented 1 year ago

The reason for that is that that the oomph repository is being set up as the repo to host organization discussions for eclipse-oomph:

image

Something the tool does not yet take into account but should be part of the configuration.