Investigate the remaining issues with pipeline schema from BB

[sdzh-atlassian]

Hello team @atlassian/axon!

I'm resolving some BB issues and decided to move this one here

We might want to investigate if it would be possible to:

1. Point the bitbucket-pipelines.yaml schema to the web instead of distributing a copy
2. Not nuke the settings on extension reinstall? (if that still happens)

This issue is prompted by 2 related issues from our old BB repo:

• Settings getting reset on extension reinstall
• Use official BB schema from @detouched

Edit - more related BB issues:

• Configuration to stop updating global settings.json's "yaml.schemas"

[detouched]

Hey @sdzh-atlassian 👋

It's safe to use the official schema, and just copying it is enough to close the gap for VS Code support of pipelines. However, in the long run I believe we need some kind of update mechanism cause we, Pipelines, keep adding features, and the schema gets updated from time to time.

The way I implemented this for IntelliJ plugin is as follows:

• fetch the latest official schema on build and bundle it in the distro
• once the plugin is loaded, copy the bundled schema into user app settings, unless there's an existing schema there (which might be newer – this can be improved if we start versioning our schema properly)
• every now and then fetch the official schema and replace the schema in user app settings in case they differ

This means there will be a recent version of the schema no matter whether the user is currently online or not, including the very first use of the plugin. I'm not claiming this to be the best mechanism though 😁

[sdzh-atlassian]

Got it, thank you very much for the explanation @detouched! Fetching the schema on the build is exactly what I had in mind, too ;)

Alternatively, maybe vscode will just let us refer to the endpoint serving the schema directly, without downloading it? 🤔

We'll see what we can do on our side, thanks again! :)

[sdzh-atlassian]

Hello again @detouched! :)

I've briefly looked into this issue a bit more, and wanted to share a fun bit of info I discovered. Apparently, if we completely remove all references to this schema file from the extension - VSCode's YAML extension will just default to using your schema from here

Since the one bit of tension with settings I could reproduce had to do with the schema settings being overwritten:

I was wondering if we could just completely nuke it, and use that default mechanism instead 🤔 This notably doesn't work offline - but might help address the remote path issues folks are reporting here and to us.

Funnily enough, I could narrow down to the fact that the schema is provided by the yaml extension - but couldn't just yet figure out where it's coming from, there xD I've also noticed that these two schemas seem to be identical:

• https://bitbucket.org/atlassianlabs/intellij-bitbucket-references-plugin/src/master/src/main/resources/schemas/bitbucket-pipelines.schema.json
• https://api.bitbucket.org/schemas/pipelines-configuration

Do you know what's the direction of the updates here? Are you pulling from https://api.bitbucket.org/schemas/pipelines-configuration periodically in that repo, or is it the other way around, and BB is just serving your schema?

[detouched]

Hey @sdzh-atlassian, sorry for late reply.

Well, this is interesting 🙂 I guess it's a legacy from the times when that schema which I hand crafted for Linky was probably the only one kept relatively up to date.

I agree the easiest move for now, and frankly speaking maybe the best in general, is to just delegate this to the mechanism in the YAML extension. No code to maintain is often the best option 😁 Offline scenario might be not that important.

It's probably also worth reaching out to the maintainers of that extension and ask them to change the schema URL to the official now one, https://api.bitbucket.org/schemas/pipelines-configuration – I'm happy to do this.

Do you know what's the direction of the updates here?

Yes, I do periodically pull from https://api.bitbucket.org/schemas/pipelines-configuration into Linky's repo (intellij-bitbucket-references-plugin). And Linky itself also periodically pulls from the same source at runtime.

I'm actually keen to get rid of that schema copy in Linky's repository, however now I feel like I should keep it there at least until VSCode YAML extension is updated to consume the official schema. Don't want to break VSCode user experience 😅