Security related recipes Source Code Links broken

[DominikZig]

It looks like the OpenRewrite Github Actions security related recipes source code links are missing the Recipe suffix, thus leading to broken links (404 pages).

It seems like these recipe links need to be suffixed with the Recipe suffix in the name? I also notice this naming convention does not seem to apply to non security related ones, e.g. AddCronTrigger.java. I'm guessing this is a new internal naming standard? Just something I observed.

What version of OpenRewrite are you using?

I am viewing the latest docs present on the website.

What is the smallest, simplest way to reproduce the problem?

On the following link: https://docs.openrewrite.org/recipes/github/security/cachepoisoningrecipe, click on the Github: CachePoisoning.java link under the 'Recipe source' header. Note this is just an example, as it seems to apply to all of the Github Action security related recipes.

What did you expect to see?

Expect to be taken to the actual source, in this case e.g https://github.com/openrewrite/rewrite-github-actions/blob/main/src/main/java/org/openrewrite/github/security/CachePoisoningRecipe.java

What did you see instead?

Leads to 404 broken link: https://github.com/openrewrite/rewrite-github-actions/blob/main/src/main/java/org/openrewrite/github/security/CachePoisoning.java

Are you interested in contributing a fix to OpenRewrite?

Yes, I'd be more than happy to open a PR to help fix this up if possible.

[timtebeek]

hey thanks for the report! Our docs are mostly generated in rewrite-recipe-markdown-generator, which has a heuristic to strip off Recipe suffix from source URLs, as that's a convention we use for our Refaster based generated recipe classes. In this case the imperative recipes themselves are mistakenly using a Recipe suffix, which is best fixed here by renaming these recipe classes. Any help appreciated!

[DominikZig]

Thanks for explaining that Tim. Sure I will raise a PR to fix up the recipe class names then

[timtebeek]

Thanks for the offer to help! Since we're getting close to a release I figured get this in quickly

• Drop Recipe suffix from security recipe class names #172

[DominikZig]

No problem, all good. I can confirm it looks good now 🙂 Apologies I didn't get around to it over the Easter weekend

[timtebeek]

No worries at all; hope you enjoyed some time off! Glad to see this confirmed fixed.