nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Generate compass.yml file

Dmitry Pashkevich_1tcvk3

I'm currently trying out compass. I like how I can quickly create and configure components via a point-and-click UI. I also appreciate the configuration-as-code support and using compass.yml as a source of truth, which we'd probably want to do in the long run. However, manually crafting the compass.yml file from scratch can be tedious (especially generating/looking up those long component/team ids). I'd love the ability to do the initial component configuration via the Compass UI, and then use a feature to "Generate compass.yml" and switch to config-as-code at that point. Is that somethign that the team has considered?

Accepted answers

Henry Olson_a2t3vz

Hi @Dmitry Pashkevich and @Orlando Kelly ! Thanks for the feedback. This is actually possible in the current state, it's just a little tricky to find

First, you'll want to install an SCM integration in the Apps page (Bitbucket, GitHub, or GitLab). Once that's installed and configured, you'll be ready to manage compass.yml files in external repos. On any component, click the "Config as Code" tab in the lefthand bar, and you'll be given a page of instructions, including a copyable compass.yml based on that component's data. For example:

Screen Shot 2022-07-07 at 9.52.42 AM.png

You can then copy and paste this file into your repository. Once that change is merged, the component should be "managed by compass.yml" and UI changes will be locked down. Hope this helps!

Henry

All comments

Orlando Kelly_roz6cy

Great Idea, I would second this.

Henry Olson_a2t3vz

Dmitry Pashkevich_1tcvk3

Ah, I see, thanks for pointing that out! I haven't set up the SCM integration because I'm not an org admin in our GitHub account, so I didn't have access to the feature.

Richard Simpson_0idq3j

It might be a stretch, but when that's integrated is there a chance a feature will be added to "commit" the generated config? Rather than having to checkout and add.

Henry Olson_a2t3vz

@Dmitry Pashkevich That's a good point - as a non-admin, would you find it useful to be able to start adding compass.yml files even before the integration is set up? I think if you just _install_ the GitHub app without configuring it, it should let you access the Config-as-Code screen, but the UI fields won't be locked down and the system won't sync compass.yml changes back to the UI until the integration is actually configured.

@rich Once you've set up your SCM integration, you can Import repos as Compass Components, and you can select an option to have it auto-generate a compass.yml file for each imported repo. The app will actually raise a PR in the repo to add it. But that only works on new repo import. @Dave Parrish [Atlassian] - it would be cool if there was a button to raise a compass.yml PR for an existing component

Welcome!

It looks like you're new here. Sign in or register to get started.