Skip to content
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

BUG: Build action message keys aren't conducive to suppressing them #219

Closed
ekoniec1 opened this issue Jul 19, 2024 · 0 comments · Fixed by #329 or #340
Closed

BUG: Build action message keys aren't conducive to suppressing them #219

ekoniec1 opened this issue Jul 19, 2024 · 0 comments · Fixed by #329 or #340
Assignees
Labels
bug Something isn't working
Milestone

Comments

@ekoniec1
Copy link

Description

When tailoring a project to exclude aiSSEMBLE-generated components that aren't needed for that project, unnecessary build notifications cannot be easily suppressed. For example, consider a project that doesn't need a PDP - adding *-policy-decision-point-docker to .gitignore and omitting PDP Helm chart generation Fermenter goals in -deploy/pom.xml is a reasonable first approach instead of creating a new set of Fermenter generation targets/profiles that exclude PDP artifacts. Following the guidance emitted guidance on message suppression:

[WARNING] To disable specific messages, please add their message keys to the suppressedMessages list. See the Fermenter docs for more info: https://github.com/TechnologyBrewery/fermenter

Executing the build with the -Dfermenter.display.message.keys=true flag yields message keys that aren't portable and contain absolute file path references:

[WARNING] ------------------------------------------------------------------------
[WARNING] Manual Action ##
[WARNING] ------------------------------------------------------------------------
[WARNING] Message Key: /Users/my-user-name/path/to/project/baz/baz-deploy/pom.xml_execution_policy-decision-point
                    <execution>
                        <id>policy-decision-point</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate-sources</goal>
                        </goals>
...
[WARNING] ------------------------------------------------------------------------
[WARNING] Manual Action ##
[WARNING] ------------------------------------------------------------------------
[WARNING] Message Key: /Users/my-user-name/path/to/project/baz/baz-docker/pom.xml_module

You must add the docker modules to baz/baz-docker/pom.xml to activate them in your build!
Example:
    <modules>
        <module>baz-policy-decision-point-docker</module>
....

As a result, most extraneous messages can't be suppressed in a consistent manner across developer workstations.

Steps to Reproduce

  1. Instantiate a new aiSSEMBLE project with pipeline(s)
  2. Execute mvn clean install -Dfermenter.display.message.keys=true before following instructions in build notifications
  3. Note how the emitted build notification message keys contain absolute paths

Expected Behavior

Build notification message keys to be emitted in a way that allows them to be portably suppressed.

Actual Behavior

Most (but not all) build notification message keys contain absolute file path references which prevents them from being ignored using Fermenter's message suppression feature

Additional Context

  • aiSSEMBLE version: 1.7.0
  • Relevant Fermenter issue that implemented configurable message suppression
@ekoniec1 ekoniec1 added the bug Something isn't working label Jul 19, 2024
carter-cundiff added a commit that referenced this issue Sep 13, 2024
carter-cundiff added a commit that referenced this issue Sep 13, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 13, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 13, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 16, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 16, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 16, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 16, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
carter-cundiff added a commit that referenced this issue Sep 16, 2024
- Update documentation to live under supporting components
- #219 improve manual action message keys
@carter-cundiff carter-cundiff added this to the 1.9.0 milestone Sep 17, 2024
@carter-cundiff carter-cundiff self-assigned this Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
2 participants