makefile: remove old docs targets #340
Merged
Conversation
This file contains 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
Since we moved the docs to integrations, we don't need to build the docs.zip file anymore, and to make it easier for plugin developers we move the logic for building the new .docs directory to the `generate' Makefile target.
Since the workflow relies on the build-docs target existing in the Makefile to ensure we don't commit a change without calling it, and since we removed it in the previous commit to fold it in generate, we don't need it anymore so we can remove it. Since the `make generate' call is already required if modifying the docs, and we check that during validate, this is safe to remove.
Since we have merged `build-docs' with `generate', we don't need to manually invoke `packer-sdc renderdocs' before the old build-docs.
Since the ci-make-docs target is no longer part of the Makefile, we cannot rely on it for making the latest docs, and therefore we must remove that from the goreleaser file too.
The docs.zip file should not be part of the release as it is no longer generated nor required to build the docs for a plugin. Keeping this in the releaser config caused the release to fail before the artifacts were updated, leading to a corrupted release.
lbajolet-hashicorp
force-pushed
the
fix_makefile_integration_docs
branch
from
d11ec35 to
134d114
Compare
JenGoldstrich
approved these changes
Oct 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since we moved the docs to integrations, we don't need to build the
docs.zip file anymore, and to make it easier for plugin developers we
move the logic for building the new .docs directory to the `generate'
Makefile target.