Skip to content

Simplify README and compose files and FE dev guide#48

Merged
rm3l merged 11 commits intoredhat-developer:mainfrom
durandom:dyn-plugins
Jun 5, 2025
Merged

Simplify README and compose files and FE dev guide#48
rm3l merged 11 commits intoredhat-developer:mainfrom
durandom:dyn-plugins

Conversation

@durandom
Copy link
Copy Markdown
Member

@durandom durandom commented Jun 2, 2025

Description

Builds on @kadel PR in #44

This PR enhances RHDH Local for frontend plugin development:

  • Added compose-dynamic-plugins-root.yaml override file for plugin development workflow
  • Integrated debug configuration into main compose.yaml and removed standalone compose-debug.yaml
  • Updated volume syntax to fix Podman compatibility issues
  • Improved Frontend Plugin Development documentation with clearer step ordering
  • Added dynamic-plugins-root to .gitignore

Which issue(s) does this PR fix or relate to

  • Improves frontend plugin development workflow
  • Addresses Podman compatibility issues

PR acceptance criteria

  • Documentation - Updated README.md Frontend Plugin Development section

How to test changes / Special notes to the reviewer

Test the updated Frontend Plugin Development workflow in README.md and verify compose-dynamic-plugins-root.yaml works correctly for plugin
development. Confirm Podman compatibility with the volume syntax changes.

durandom added 6 commits June 2, 2025 14:59
Signed-off-by: Marcel Hild <hild@b4mad.net>
…issues

Signed-off-by: Marcel Hild <hild@b4mad.net>
Signed-off-by: Marcel Hild <hild@b4mad.net>
…licity

Signed-off-by: Marcel Hild <hild@b4mad.net>
…EADME.md with frontend plugin development instructions

Signed-off-by: Marcel Hild <hild@b4mad.net>
Signed-off-by: Marcel Hild <hild@b4mad.net>
Comment thread README.md Outdated
Signed-off-by: Marcel Hild <hild@b4mad.net>
Copy link
Copy Markdown
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall - thanks. Just a few minor comments.

Comment thread README.md Outdated
Comment thread README.md
Comment thread .github/workflows/test.yml Outdated
Comment thread .github/workflows/test.yml Outdated
Comment thread .github/workflows/test.yml Outdated
Copy link
Copy Markdown
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label Jun 3, 2025
Signed-off-by: Marcel Hild <hild@b4mad.net>
@durandom
Copy link
Copy Markdown
Member Author

durandom commented Jun 5, 2025

@rm3l @kadel - I removed the "selinux" section from the README and moved the "known issues" to the bottom.
So, I think this is good to go

Comment thread .github/workflows/test.yml Outdated
Comment thread compose-dynamic-plugins-root.yaml Outdated
durandom added 2 commits June 5, 2025 12:15
…and remove Podman Compose warning from YAML

Signed-off-by: Marcel Hild <hild@b4mad.net>
…ndition

Signed-off-by: Marcel Hild <hild@b4mad.net>
Copy link
Copy Markdown
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label Jun 5, 2025
@rm3l rm3l merged commit 37be302 into redhat-developer:main Jun 5, 2025
13 checks passed
Fortune-Ndlovu pushed a commit to Fortune-Ndlovu/rhdh-local that referenced this pull request Jun 17, 2025
* feat: add compose file for dynamic plugins configuration

Signed-off-by: Marcel Hild <hild@b4mad.net>

* refactor: use short syntax for volumes to workaround podman override issues

Signed-off-by: Marcel Hild <hild@b4mad.net>

* docs: improve README.md known issues for Podman

Signed-off-by: Marcel Hild <hild@b4mad.net>

* feat: include compose-debug.yaml into main compose.yaml file for simplicity

Signed-off-by: Marcel Hild <hild@b4mad.net>

* feat: update .gitignore to include dynamic-plugins-root and enhance README.md with frontend plugin development instructions

Signed-off-by: Marcel Hild <hild@b4mad.net>

* docs: update README.md to simplify dynamic plugins setup steps

Signed-off-by: Marcel Hild <hild@b4mad.net>

* feat: add dynamic-plugins-root configuration to CI workflow

Signed-off-by: Marcel Hild <hild@b4mad.net>

* feat: simplify dynamic plugins directory creation step in CI workflow

Signed-off-by: Marcel Hild <hild@b4mad.net>

* docs: update README.md moving known issues with Podman Compose

Signed-off-by: Marcel Hild <hild@b4mad.net>

* refactor: simplify dynamic plugins directory creation in CI workflow and remove Podman Compose warning from YAML

Signed-off-by: Marcel Hild <hild@b4mad.net>

* fix: correct quotation marks in dynamic plugins directory creation condition

Signed-off-by: Marcel Hild <hild@b4mad.net>

---------

Signed-off-by: Marcel Hild <hild@b4mad.net>
Co-authored-by: Tomas Kral <tkral@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants