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

blog:bot helper CI Job #293

Merged
merged 1 commit into from
Apr 26, 2022
Merged

Conversation

SubhasmitaSw
Copy link
Contributor

Reference #31919

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 15, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @SubhasmitaSw!

It looks like this is your first PR to kubernetes/contributor-site 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/contributor-site has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 15, 2022
@k8s-ci-robot k8s-ci-robot requested review from jberkus and jeefy March 15, 2022 15:48
---
layout: blog
title: "K8s Triage bot Helper CI Job: ‘*make update*’"
date: 2022-03-15
Copy link
Contributor

Choose a reason for hiding this comment

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

what's your actual target publication date?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The actual date stands at 2022-02-25, should it be changed?

Copy link
Contributor

Choose a reason for hiding this comment

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

This should be a date in the future. Ideally, co-ordinate that date with the k/website blog team (eg: talk to me) as well so that it goes out on a day when no k/website PRs are due.

@jberkus
Copy link
Contributor

jberkus commented Mar 15, 2022

Hey, thanks for this blog post! It looks great and will be really helpful for devs on Windows.

However, there are a bunch of formatting issues with it. One is that your use of sub-heads is odd and I don't think will flow well for the reader. The second is the lack of descriptions for any images. Finally, you use several different forms of code blocking, some of which I don't think work, unless they're special Hugo codes I don't know about.

Happy to help you revise this.

@SubhasmitaSw
Copy link
Contributor Author

SubhasmitaSw commented Mar 26, 2022

Hey, thanks for this blog post! It looks great and will be really helpful for devs on Windows.

However, there are a bunch of formatting issues with it. One is that your use of sub-heads is odd and I don't think will flow well for the reader. The second is the lack of descriptions for any images. Finally, you use several different forms of code blocking, some of which I don't think work, unless they're special Hugo codes I don't know about.

Happy to help you revise this.

I used formatting from the HackMd to which rendering seems problematic for the Github markdown. I have rectified a large portion of the things and added a description to conceivably every picture. Thanks for suggesting improvements and apology for being late.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Here's some more feedback. I think this is a really valuable article to publish, so I hope you find these suggestions useful @SubhasmitaSw.

---
layout: blog
title: "K8s Triage bot Helper CI Job: ‘*make update*’"
date: 2022-03-15
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be a date in the future. Ideally, co-ordinate that date with the k/website blog team (eg: talk to me) as well so that it goes out on a day when no k/website PRs are due.

@SubhasmitaSw SubhasmitaSw force-pushed the CIJobBlog branch 2 times, most recently from e41c8c8 to 2968d3f Compare March 29, 2022 18:32
Copy link
Contributor

@jberkus jberkus left a comment

Choose a reason for hiding this comment

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

A few more formatting issues -- mostly inappropriate use of block quotes.

Also, I don't quite understand the flow of the blog around the solutions, see comment.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

I'm afraid I still see lots of things to fix

Comment on lines 94 to 95
* **Short Term:** add a CI job that folks can trigger when they need it, that runs `make update` and provides a zip archive that they can be told to download. The archive includes all the files that changed as a result of running `make update`.
* **Long Term:** add a new Prow bot command that generates an additional commit on their PR.
Copy link
Contributor

Choose a reason for hiding this comment

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

You could make the text “Short Term” and “Long Term” be hyperlinks to the relevant headings.

![artifacts directory](jenkins.png)

Now, update the PR by adding the extracted files you downloaded.

Copy link
Contributor

Choose a reason for hiding this comment

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

There's no heading or steps about using the long term solution. Folks might wonder where that has gone.

My guess is that the long term solution is still a work in progress and you can't use it yet? Whatever the story is, let's make that really clear.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have an idea how to arrange this better, suggestion coming.

Comment on lines 20 to 24
### System info:

| OS name | Version | System type |Memory| WSL |
| ------- | ------- | ----------- | --- | --- |
|Windows 11 home|10.0.22000 Build 22000|x64-based|8.00 GB|Ubuntu-20.04 (v2)|
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this needed? I'd omit it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, it doesn't fit entirely to the article's context.

@SubhasmitaSw SubhasmitaSw force-pushed the CIJobBlog branch 2 times, most recently from f059ccb to a4ba2cf Compare April 1, 2022 06:26
Copy link
Contributor

@jberkus jberkus left a comment

Choose a reason for hiding this comment

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

Looks good to me. Let's schedule it and merge it!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jberkus, SubhasmitaSw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 14, 2022
@SubhasmitaSw
Copy link
Contributor Author

Looks good to me. Let's schedule it and merge it!

Please let me know where we shall communicate the schedule date either on slack or here itself.

@sftim
Copy link
Contributor

sftim commented Apr 26, 2022

Try to avoid merging long before the scheduled date due to #281

Also, please don't pick a date that's close to the v1.24 Kubernetes release.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

@SubhasmitaSw the filename: 2022-03-15-k8s-triage-bot-helper-ci-job/K8s Triage bot Helper CI Job_ ‘make update’.md contains special characters. How about k8s-bot-helper-ci-job.md?

I also suggested a title that doesn't contain asterisks and suchlike.

---
layout: blog
title: >-
"K8s Triage bot Helper CI Job: ‘*make update*’"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"K8s Triage bot Helper CI Job: ‘*make update*’"
Kubernetes Build Helper CI job: Run "make update" within CI

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was changing those, I accidentally deleted the last changes when my pc went down. I shall push them soon.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you have that update available you could open a new PR to update it. I'm afraid that would have to be a brand new PR as this one already merged.

@SubhasmitaSw
Copy link
Contributor Author

Try to avoid merging long before the scheduled date due to #281

Also, please don't pick a date that's close to the v1.24 Kubernetes release.

The suggested date by @jberkus is 26/4.

@sftim
Copy link
Contributor

sftim commented Apr 26, 2022

Publishing on 2022-04-26 would be fine for the Kubernetes blog team. Ideally, update kubernetes/website#31919 to match the text of this one as well, so we can get them both published close together.

@jberkus
Copy link
Contributor

jberkus commented Apr 26, 2022

/lgtm

Let's publish now.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 26, 2022
@k8s-ci-robot k8s-ci-robot merged commit 8c452f9 into kubernetes:master Apr 26, 2022
@SubhasmitaSw SubhasmitaSw mentioned this pull request Apr 27, 2022
Comment on lines +27 to +31
![Failed Test Cases](failing_test_cases.png)

Consecutively,

![Failed Test Cases robot comment](k8s_ci_failed_tests.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

BTW, I don't think these images are working in the published article.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm concerned about this too, what could be causing this? Maybe the file is moved to some location not containing the images

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants