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

Allow mapping of build steps to github statuses #576

Closed
dan-kirberger opened this issue Apr 27, 2022 · 3 comments · Fixed by go-vela/server#1090
Closed

Allow mapping of build steps to github statuses #576

dan-kirberger opened this issue Apr 27, 2022 · 3 comments · Fixed by go-vela/server#1090
Assignees
Labels
area/worker Indicates a change to the worker feature Indicates a new feature

Comments

@dan-kirberger
Copy link

Description

It's handy to have multiple github statuses to track parts of your build (say, one for the lint step, one for build, one for automated tests, etc).

It's a bit clumsy setting that up in Vela currently, as we have to explicitly send github statuses before and after each step we care about.

Would it be possible to handle more of that for us?

Say:

- name: lint
  image: some-node-image
  context: Linting
  commands:
    - yarn lint

With the above context field above, it will manage a "Linting" status on github, viewable from the pull request:
image

When this exists, it would automatically set the status to "pending" for all contexts when a build starts, and update to success/failure as necessary. In addition, the link provided in the github status would be a link to that specific build step in vela.

Value

Its very handy to view a PR at a glance and see which steps passed/failed, with direct links to the steps in question.

Definition of Done

@dan-kirberger dan-kirberger added the feature Indicates a new feature label Apr 27, 2022
@cognifloyd
Copy link
Member

That's a cool idea. I don't know about reporting at a step level, but I can see using something like this for each stage.

I'm not sure context clearly describes what this does, so another keyword might be better. What about report:? That doesn't seem to fit as well either, hmm. I'll have to noodle some more on it.

@dan-kirberger
Copy link
Author

Yeah good call. "Context" is the name of it on the GitHub status api but you're right, it is a bit too vague here.

Stage would work too!

@ecrupper ecrupper self-assigned this May 2, 2022
@wass3r
Copy link
Collaborator

wass3r commented Sep 2, 2022

maybe it's a boolean and takes on the name of the step as the "context"? that way you can't cause confusion by naming it "linting" when it actually happened on a step called "push-to-prod"?

also a little bit worried about potential for api abuse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/worker Indicates a change to the worker feature Indicates a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants