Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[updoc] Check for errors while walking the filesystem #201

Merged
merged 2 commits into from
Apr 5, 2024

Conversation

ulucinar
Copy link
Contributor

@ulucinar ulucinar commented Apr 5, 2024

Description of your changes

@turkenf hit an issue while trying to publish marketplace documents of the upbound/provider-terraform repository.

We've identified the configuration error in that repository to resolve that issue but we've also spotted an error checking bug in updoc. This PR adds an error check while walking the filesystem to discover the docs to be published.

It also parameterizes the updoc version that a provider repo is using and sets the default to a version containing the new fix.

I have:

  • Run make reviewable test to ensure this PR is ready for review.

How has this code been tested

Locally reproduced the configuration issue and we now log the underlying error:

2024/04/05 17:20:35 lstat ./docs/monolith: no such file or directory

Post merge note:
We've also verified that the underlying errors are properly reported here:
image

- Add the input parameter "updoc-version" to parameterize the
  version of updoc being used in the "Updoc" workflow

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
@ulucinar ulucinar changed the title [updoc]: Check for errors while walking the filesystem [updoc] Check for errors while walking the filesystem Apr 5, 2024
Copy link
Contributor

@turkenf turkenf left a comment

Choose a reason for hiding this comment

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

Thank you @ulucinar, LGTM.

@ulucinar ulucinar merged commit f2ad7dd into upbound:main Apr 5, 2024
6 checks passed
@ulucinar ulucinar deleted the fix-errcheck branch April 5, 2024 14:33
Copy link

github-actions bot commented Apr 5, 2024

Successfully created backport PR #202 for standard-runners.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants