[MAINT]: build fails during anicca step

[wolfy1339]

Describe the need

When running the build command, the anicca diff fails

SDK Version

No response

API Version

N/A

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[wolfy1339]

This is blocking updates to the spec currently.

I linted the OpenAPI spec using redocly and it found some issues.
While some of the issues it reported are valid, they are safe to ignore, like ones from the security-defined, operation-4xx-response.
Some others, generated by the spec rule, show many different places in the spec that aren't valid.

The type field must be defined when the nullable field is used.

Those errors may or may not be the cause of anicca failing but would be a good start

[gr2m]

Unfortunately anicca is no longer maintained. But it was the only tool I found back in the days that was capable of diffing the OpenAPI versions of GitHub's huge specifications. Maybe there is a new tool out there that could be used instead, it's been a while since I checked.

[wolfy1339]

In the mean time that we find another tool, could we disable it to get updates working again?

[gr2m]

you mean disabling generating the diff files? Okay with me, is it the only thing we use anicca for? It's been a long while since I looked into it

[wolfy1339]

Yeah, it's the only thing anicca is used for. We don't process the diff files further down the pipeline currently anyways

[gr2m]

okay then, let's disable it for now 👍🏼 thanks for checking

[nickfloyd]

I could always see if @xuorig would be willing to transfer ownership of the repo, but one of the reasons it's public archive is because he made loads of amazing progress on it but went on to new adventures and I simply didn't have the time to put into getting it the rest of the way. I doubt I'd be able to continue pushing forward on it.

I've asked some of our Microsoft friends who work with large OpenAPI schema sets to see if there are any alternatives out there - we tried close to 10 different tools before deciding to roll our own. We have used openapi-diff with some success if we think this is an important step to protect our users. I personally don't have a solid opinion on the real benefits on having this step here.

[gr2m]

I personally don't have a solid opinion on the real benefits on having this step here.

I think that the diff files should ideally be generated in https://github.com/github/rest-api-description/, and they should be released with proper release notes. That way a much larger consumer base would benefit and the Octokit team wouldn't need to continue maintaining the process.

Reviewing the OpenAPI differences is a time consuming effort, having proper changelogs would save a lot of time, we wouldn't need to create them by hand. Or at least we would have a great baseline to start with that is not a code diff too large too handle for github.com 🤣

[nickfloyd]

I love that line of thinking @gr2m. I'll start the conversation with the owners of that repo.

[octokitbot]

🎉 This issue has been resolved in version 12.1.1 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[xuorig]

Hey folks, I'd be open to reviving Anicca if there is interest / still not a better solution.

I tried fixing it today and I'm currently blocked by this: github/rest-api-description#3001

[nickfloyd]

I tried fixing it today and I'm currently blocked by this: github/rest-api-description#3001

Hey @xuorig let me look into the OpenAPI issue. Sorry for the trouble there.