Fix MacVim CI not re-generating help tags properly #1286
Merged
Conversation
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
We previously added a step to rebuild the Vim help tags when publishing so that we could get the latest tags when generating a MacVim release (sometimes Vim's runtime is lagging behind and doesn't have that done). However, the step was so placed so far back (after building/testing) that it doesn't actually do anything, as MacVim was already built. Move it earlier so we build MacVim after vimtags are re-generated. As part of doing this we also need to split building Vim itself earlier as vimtags generation requires having a Vim binary. So the updated steps are 1. Vim, 2. help tags, 3. MacVim, 4. Tests. Previously they were 1. Vim/MacVim, 2. Tests, 3. help tags.
ychin
added a commit
to ychin/macvim
that referenced
this pull request
Sep 8, 2023
Previously, Vim didn't always have up-to-date help tags. As a result, we just manually generate the help tags when publishing a release (macvim-dev#1286), even though it doesn't actually make sure the tags file in source is actually accurate. However, Vim has since added CI checks to make sure the help tags are correct, so we can change MacVim CI to do the same thing as well. This way, the source version is always correct and we won't rely on a build step during release to fix it, and it also makes sure other methods to get MacVim (build from source, Homebrew) will be correct as well.
ychin
added a commit
to ychin/macvim
that referenced
this pull request
Sep 9, 2023
Previously, Vim didn't always have up-to-date help tags. As a result, we just manually generate the help tags when publishing a release (macvim-dev#1286), even though it doesn't actually make sure the tags file in source is actually accurate. However, Vim has since added CI checks to make sure the help tags are correct, so we can change MacVim CI to do the same thing as well. This way, the source version is always correct and we won't rely on a build step during release to fix it, and it also makes sure other methods to get MacVim (build from source, Homebrew) will be correct as well.
ychin
added a commit
to ychin/macvim
that referenced
this pull request
Sep 9, 2023
Previously, Vim didn't always have up-to-date help tags. As a result, we just manually generate the help tags when publishing a release (macvim-dev#1286), even though it doesn't actually make sure the tags file in source is actually accurate. However, Vim has since added CI checks to make sure the help tags are correct, so we can change MacVim CI to do the same thing as well. This way, the source version is always correct and we won't rely on a build step during release to fix it, and it also makes sure other methods to get MacVim (build from source, Homebrew) will be correct as well.
ychin
added a commit
to ychin/macvim
that referenced
this pull request
Sep 9, 2023
Previously, Vim didn't always have up-to-date help tags. As a result, we just manually generate the help tags when publishing a release (macvim-dev#1286), even though it doesn't actually make sure the tags file in source is actually accurate. However, Vim has since added CI checks to make sure the help tags are correct, so we can change MacVim CI to do the same thing as well. This way, the source version is always correct and we won't rely on a build step during release to fix it, and it also makes sure other methods to get MacVim (build from source, Homebrew) will be correct as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
We previously added a step to rebuild the Vim help tags when publishing so that we could get the latest tags when generating a MacVim release (sometimes Vim's runtime is lagging behind and doesn't have that done).
However, the step was so placed so far back (after building/testing) that it doesn't actually do anything, as MacVim was already built. Move it earlier so we build MacVim after vimtags are re-generated. As part of doing this we also need to split building Vim itself earlier as vimtags generation requires having a Vim binary.
So the updated steps are 1. Vim, 2. help tags, 3. MacVim, 4. Tests. Previously they were 1. Vim/MacVim, 2. Tests, 3. help tags.