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

fix(docs): Update buildkit example #12999

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

highb
Copy link
Contributor

@highb highb commented Apr 30, 2024

Motivation

There are two issues with the buildkit example: 1) The default branch is master but the argo-workflows repo only has main 2) The build task refers to a go project that no longer exists in this repo.

Modifications

  • Updated the default branch for the example to main
  • Removed the build step entirely from the example

If preferred, I could modify the build step to use the example go project from that example workflow instead.

Verification

Ran the workflow from my local Argo workflows instance after setting up the Docker credentials as noted by the example.

There are currently two issues with the current buildkit example:
1) The default branch is `master` but the argo-workflows repo only has `main`
2) The build task refers to a go project that no longer exists in this repo.

To fix the issues:
* I updated the default branch to `main`
* I've removed the `build` step entirely.

If preferred, I could modify the build step to use the example go project from that example workflow instead.

Signed-off-by: Brandon High <[email protected]>
@highb highb marked this pull request as ready for review April 30, 2024 23:32
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

Thanks for updating the outdated contents of this example!

I definitely missed main here in #12149, although GH should redirect the request such that it still works, did it not?

If preferred, I could modify the build step to use the example go project from that example workflow instead.

I think we do want to show a build step in this example for it to more closely resemble a standard build pipeline.

@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Apr 30, 2024
@agilgur5 agilgur5 changed the title fix: Update buildkit example fix(docs): Update buildkit example May 1, 2024
@agilgur5 agilgur5 added the problem/more information needed Not enough information has been provide to diagnose this issue. label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs problem/more information needed Not enough information has been provide to diagnose this issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants