Graphql-engine: infra: add check for images in docs

Created on 28 Sep 2020  路  9Comments  路  Source: hasura/graphql-engine

Motivation

As explained in this guide, we should compress images that are added as part of a docs pull request. This sometimes gets forgotten and then a PR gets merged with too large images.

Instructions

We should make this part of the PR process. I've added a label called docs-compress-images.

We should write a GitHub action that checks the following:

  • Is it a docs PR?
  • Has one or more images been added?

If the answer to both is yes, the build should only succeed if the label docs-compress-images is added. Otherwise it should fail.

Reference

We have a similar (yet not exactly the same) use case for the changelog label. You can check it out for inspiration.

build-system docs wip

Most helpful comment

@Hard-Coder05 @wicked-smart thank you both for your PR. Please be nice to each other, it's all good. We don't assign issues as explained in our Hacktoberfest blogpost.

@Hard-Coder05 I made a comment on your PR.

@wicked-smart it's great that you've started contributing to open source. Let's leave your PR open for now, until the other one is merged. We explain in the blogpost how to look for issues. If you need help, it's also explained in the blogpost where to get it 馃檪

All 9 comments

@marionschleifer
Is it like the default PR form must contain two checkboxes asking 1.) is it a docs PR and 2.) has one or more images been added, then if both are yes then add "docs-compress-image" tag on the PR

@Hard-Coder05 no, no check boxes. It's supposed to be a Github action that is doing these checks.

@marionschleifer I am working on it! Please assign it to me!

Hi, @marionschleifer , my all checks have passed. Can you take a look into it?

P.S:- Major Noob here regarding opensource contributions, please excuse if i do something silly :-)

@wicked-smart
I have made a PR on the same issue! How can you make a PR for a issue which is taken?

@Hard-Coder05 ok boss , my bad ...relax !!! , as i said i'm quite new to this. I guess one needs to get assigned to make PR . I saw your check didn't passed , so then fixed it and pushed.

Alright, buddy, please enlighten me on what should i do now....is there a thing called deleting PR or something ?

@Hard-Coder05 @wicked-smart thank you both for your PR. Please be nice to each other, it's all good. We don't assign issues as explained in our Hacktoberfest blogpost.

@Hard-Coder05 I made a comment on your PR.

@wicked-smart it's great that you've started contributing to open source. Let's leave your PR open for now, until the other one is merged. We explain in the blogpost how to look for issues. If you need help, it's also explained in the blogpost where to get it 馃檪

@marionschleifer yes sure! am working on it!

@marionschleifer Thanks for your considerate response. Since I was to learn and implement a GitHub action , which I think is pretty cool tool for effectively automating CI/CD pipeline at scale, I chose this issue ...Anyway, will be going through other Hacktoberfest labelled issues for a potential PR

Was this page helpful?
0 / 5 - 0 ratings