Skip to content

makefile: remove old docs targets#155

Merged
nywilken merged 6 commits intomainfrom
fix_makefile_integration_docs
Oct 10, 2023
Merged

makefile: remove old docs targets#155
nywilken merged 6 commits intomainfrom
fix_makefile_integration_docs

Conversation

@lbajolet-hashicorp
Copy link
Copy Markdown
Contributor

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.

@lbajolet-hashicorp lbajolet-hashicorp requested a review from a team as a code owner September 21, 2023 19:37
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.
When the docs were modified last, the web-docs weren't updated, and the
action did not trigger on that branch, leading to the pipelines failing
after that, so we fix this issue now.
@lbajolet-hashicorp lbajolet-hashicorp force-pushed the fix_makefile_integration_docs branch from 1d76ff0 to 43298c6 Compare September 21, 2023 20:51
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 lbajolet-hashicorp force-pushed the fix_makefile_integration_docs branch from 1042a56 to 88ec2ae Compare September 26, 2023 20:20
Copy link
Copy Markdown
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nywilken nywilken merged commit f6dc59b into main Oct 10, 2023
@nywilken nywilken deleted the fix_makefile_integration_docs branch October 10, 2023 18:03
@vmware vmware locked and limited conversation to collaborators Jun 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants