How do I make components from my monorepo actually show up in Compass

Alexander October 25, 2024

I've added about ~100 compass.yaml files in our monorepo to describe the various components that we have. However, so far although our GitHub integration says it's working, there has been 0 activity in Compass. No errors, no buttons to click, no progress.

The documentation says this should work, but doesn't say how it should work or what magic incantation I need to perform to get Compass to do something. There's the frustrating option to import a repository which just creates a single component for our repository. However, our repository itself isn't a thing, but only a container for all our actual components. So that's not what I want.

1 answer

1 accepted

1 vote
Answer accepted
Tyler T
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
October 28, 2024

Hi @Alexander and welcome to the Community!

Your team will need to add the monorepo repository to Compass in order for the yaml files to be detected in Compass.

Then you should see 100 new components created. After your components are added, you can archive/delete the original monorepo component.

Compass is actively working on some new features to provide better monorepo support. I've marked your name down as someone to contact as soon as they become available.

Let us know if this solved your issue!

Tyler

Alexander October 29, 2024

Hi Tyler, thanks for jumping in!

I think for me the confusing thing about these directions (which I tried before) is that the success message is "1 components created"; after which I only see the repository component and none of my other components.

Is there a time delay for it to import the other components or should that have happened immediately? Should I promote my repository component from "Pending" to "Active" first?

One possible problem that I could see is that I set the `tier` in all my component files to `null`. In my mind this would be the same as omitting the field but has the benefit of documenting it to other developers.

However, I'm not seeing any errors along the line of "100 compass.yaml files detected that contain errors" (I'd be happy knowing there are errors without knowing what errors at this point in the journey).

Looking forward to the new and improved features :D In the meantime it looks like I'm missing a step somewhere.

Like Steffen Opel _Utoolity_ likes this
Alexander October 29, 2024

Hi @Tyler T

Just wanted to update this. The repository component has now been sitting active since I created it after posting my first message.

None of the other components have shown up, nor do I have any new errors or notifications in Compass that tell me what's wrong. The repository has seen new commits since then (though the compass.yaml files haven't changed).

Enrique Serrano Valle
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 5, 2024

@Alexander thank you for the update.

The config-as-code functionality of Compass wasn't initially designed to work with monorepos, but we are currently working to improve support for them. I can see how a big set of files changed, including several compass.yaml files, could have caused component creations to be missed.

Since it looks like the connection between the repository and Compass is otherwise successful, as a temporary solution for config-as-code syncing, you can try removing and then re-adding the compass.yaml files that did not create new components. This should trigger the creation of new components for those files. Doing that in smaller batches should ensure that the changes are detected and applied successfully.

Please let me know if this helps. We'll keep the community posted about upcoming improvements in this front.

Alexander November 6, 2024

Hi @Enrique Serrano Valle ,

Would the system work if I just create the components manually instead and then add the ID to the file 10 at a time? That's a lot less work than removing everything and re-adding the files.

I'm also trying to minimize the amount of commit noise I create due to the active development going on in the repository and the fact I'll have to do this for more repositories after.

Otherwise I might just have to discuss internally that we wait with adoption of Compass until that ingestion process improves or find an alternative.

Thanks!

Like # people like this
Enrique Serrano Valle
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 6, 2024

@Alexander that's an even better idea. The approach that you're suggesting would work perfectly.

Like Steffen Opel _Utoolity_ likes this

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events