Skip CI & memcheck when pushing v* tags#120
Merged
Conversation
saulecabrera
approved these changes
Jan 23, 2023
jbourassa
added a commit
that referenced
this pull request
Sep 19, 2024
YARD doc generation is broken in a few different ways, this change aims to fix all the known issues. Fixes #342. **Issues:** 1. Docs for tagged releases (vx.y.z tags) was last generated for v6.0.0 because we stopped running CI in on versions in #120. This means that the current "latest" doc symlink points to v6.0.0, helping other doc issues go unnoticed (see next points). Fix: run the doc generation step on release as well. 2. YARD doc generation stopped working at some point last year when we updated the nightly version. The doc for main only has a handful of Ruby-defined APIs, but none of the Rust-defined APIs. The root cause is a change in rustdoc's JSON format which caused yard-rustdoc to miss all definitions. Fix: teach yard-rustdoc about the new format, and update the dependency. This will also fix an issue causing `Wasmtime::Memory::UnsafeSlice` to not show up in the class list sidebar. See: oxidize-rb/yard-rustdoc@v0.3.2...v0.4.0 3. Documentation entries had issues (invalid names, missing args, etc.) This would normally be caught in CI, but they weren't given the docs for Rust-defined APIs were skipped (see above point).
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This should not be needed assuming
mainis green. It'll speed up builds and avoid wasting resources.