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

[Bug]: GitHub badges on the root README do not reflect any meaningful status #1051

Closed
1 task done
bourgeoisor opened this issue Sep 19, 2023 · 2 comments · Fixed by #1060
Closed
1 task done

[Bug]: GitHub badges on the root README do not reflect any meaningful status #1051

bourgeoisor opened this issue Sep 19, 2023 · 2 comments · Fixed by #1060
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@bourgeoisor
Copy link
Member

Version of Cloud Ops Sandbox

N/A

Your client machine OS?

iOS

Tell us, what is a problem?

Currently, the badges on the root README do not show any meaningful status. They show the latest status of these workflows:

But since these workflows only runs on PRs (and not on main), the badges reflect the status of the last PR that happened to have ran those workflows (whether or not that PR has even been merged in).

What you expected to happen?

We should:

  • Make sure that the Terraform and CLI workflows run both on PRs and on main
  • Update the root README badges to only show "latest main" run of these workflows (not PRs)

Code of Conduct

  • I agree to follow this project's Code of Conduct
@bourgeoisor bourgeoisor added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. triage me I really want to be triaged. labels Sep 19, 2023
@minherz
Copy link
Collaborator

minherz commented Sep 19, 2023

Cloud Ops Sandbox adapts the trunk-based model. In this model each release is maintained in the dedicated branch and the main branch may represent the current development status of the development on top of the latest X.Y.Z version.

The current goal for showing the status of the latest CLI and Terraform workflows was based on certain expectations for the development velocity that did not come true.

What is a goal of the request to "only show latest main run"? Limiting the aforementioned workflows to run only on PRs that submitted to the main branch prevents any development work that takes place in any other branch from being validated vs. these workflows.

@minherz minherz added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed triage me I really want to be triaged. labels Sep 21, 2023
@minherz
Copy link
Collaborator

minherz commented Sep 21, 2023

It is decided that we remove the badges from the README file at the root of the repo for now. The badges will be removed no later than 0.10.0 version release

minherz added a commit that referenced this issue Nov 21, 2023
comment markdown to show status badges. fixes #1051
update the subcommand for gcloud auth. partially fixes #1047
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
2 participants