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

Add more CI status badges to README #26090

Merged
merged 3 commits into from Oct 16, 2020
Merged

Add more CI status badges to README #26090

merged 3 commits into from Oct 16, 2020

Conversation

ceyhun
Copy link
Member

@ceyhun ceyhun commented Oct 14, 2020

Added all the GitHub Actions workflow badges to the README. Seems a bit crowded now, any ideas about the layout appreciated!

@ceyhun ceyhun added the [Type] Developer Documentation Documentation for developers label Oct 14, 2020
@ceyhun ceyhun requested review from gziolo and guarani October 14, 2020 09:17
@github-actions
Copy link

github-actions bot commented Oct 14, 2020

Size Change: -4.33 kB (0%)

Total Size: 1.19 MB

Filename Size Change
build/a11y/index.js 1.14 kB +1 B
build/annotations/index.js 3.54 kB +22 B (0%)
build/autop/index.js 2.72 kB -1 B
build/blob/index.js 668 B +1 B
build/block-directory/index.js 8.6 kB +39 B (0%)
build/block-editor/index.js 130 kB +28 B (0%)
build/block-library/index.js 142 kB -1.5 kB (1%)
build/block-library/style-rtl.css 7.71 kB +2 B (0%)
build/block-library/style.css 7.71 kB +2 B (0%)
build/blocks/index.js 47.6 kB -3 B (0%)
build/components/index.js 169 kB +318 B (0%)
build/components/style-rtl.css 15.4 kB -63 B (0%)
build/components/style.css 15.4 kB -61 B (0%)
build/compose/index.js 9.63 kB -6 B (0%)
build/core-data/index.js 12.1 kB +13 B (0%)
build/data-controls/index.js 684 B -1 B
build/data/index.js 8.63 kB -3 B (0%)
build/date/index.js 31.9 kB -3 B (0%)
build/dom-ready/index.js 569 B +1 B
build/dom/index.js 4.43 kB +2 B (0%)
build/edit-navigation/index.js 10.6 kB -3 B (0%)
build/edit-post/index.js 306 kB +29 B (0%)
build/edit-site/index.js 21.1 kB -185 B (0%)
build/edit-site/style-rtl.css 3.77 kB -91 B (2%)
build/edit-site/style.css 3.77 kB -92 B (2%)
build/edit-widgets/index.js 21.4 kB +159 B (0%)
build/editor/index.js 42.5 kB -2.95 kB (6%)
build/element/index.js 4.45 kB +1 B
build/escape-html/index.js 733 B -1 B
build/i18n/index.js 3.54 kB +1 B
build/is-shallow-equal/index.js 709 B -1 B
build/keyboard-shortcuts/index.js 2.39 kB -1 B
build/list-reusable-blocks/index.js 3.02 kB +2 B (0%)
build/media-utils/index.js 5.12 kB -1 B
build/notices/index.js 1.69 kB +2 B (0%)
build/nux/index.js 3.27 kB +6 B (0%)
build/plugins/index.js 2.44 kB +1 B
build/primitives/index.js 1.34 kB +1 B
build/priority-queue/index.js 789 B -1 B
build/redux-routine/index.js 2.85 kB +2 B (0%)
build/rich-text/index.js 13 kB +5 B (0%)
build/shortcode/index.js 1.7 kB +1 B
build/url/index.js 4.07 kB +3 B (0%)
build/viewport/index.js 1.75 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/api-fetch/index.js 3.35 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/style-rtl.css 10.9 kB 0 B
build/block-editor/style.css 10.9 kB 0 B
build/block-library/editor-rtl.css 8.65 kB 0 B
build/block-library/editor.css 8.65 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-default-parser/index.js 1.78 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/deprecated/index.js 772 B 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/edit-post/style-rtl.css 6.3 kB 0 B
build/edit-post/style.css 6.29 kB 0 B
build/edit-widgets/style-rtl.css 2.97 kB 0 B
build/edit-widgets/style.css 2.97 kB 0 B
build/editor/editor-styles-rtl.css 480 B 0 B
build/editor/editor-styles.css 482 B 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.84 kB 0 B
build/format-library/index.js 7.49 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/html-entities/index.js 622 B 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/reusable-blocks/index.js 3.04 kB 0 B
build/server-side-render/index.js 2.6 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Contributor

@guarani guarani left a comment

Choose a reason for hiding this comment

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

I previewed it here:

Screen Shot 2020-10-14 at 09 39 04

I think it doesn't look overly crowded, although if some of the workflows had shorter names it could work better, e.g.:

Before After
Performance Tests Perf Tests
End-to-End Tests Web E2E Tests
Static Analysis (Linting, License, Type checks...) Static Analysis
Unit Tests Web Unit Tests
Create Block Create Block (leave as is)
Storybook GitHub Pages Storybook
React Native E2E Tests (iOS) iOS E2E Tests
React Native E2E Tests (Android) Android E2E Tests
Compressed Size Compressed Size (leave as is)

What do you think?

@gziolo
Copy link
Member

gziolo commented Oct 14, 2020

Thank you for opening a follow-up PR. How about we remove some of the less important badges to make sure it isn't so crowded? I think some of those jobs integrate with workflows in PRs before merging like Compressed Size or Performance Tests. @youknowriad should know better.

@youknowriad
Copy link
Contributor

True, the storybook deploy too, though to be honest, I don't care much about whether it's crowded or not :P

@ceyhun
Copy link
Member Author

ceyhun commented Oct 15, 2020

Just removed some of the badges and seems to look better now.
@guarani I'm not sure if it's possible to change the text in the badges as the badge svg already comes with it: for example. It might also be confusing to use different names than workflows for the badges.

@guarani guarani self-requested a review October 15, 2020 12:31
@guarani
Copy link
Contributor

guarani commented Oct 15, 2020

Just removed some of the badges and seems to look better now.
@guarani I'm not sure if it's possible to change the text in the badges as the badge svg already comes with it: for example. It might also be confusing to use different names than workflows for the badges.

Looks good to me, @ceyhun!

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Looks great 🙌

@gziolo gziolo merged commit 96dfbd7 into master Oct 16, 2020
@gziolo gziolo deleted the add/more-ci-status-badges branch October 16, 2020 15:01
@github-actions github-actions bot added this to the Gutenberg 9.2 milestone Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants