Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix README Build Status #16183

Merged
merged 3 commits into from
Sep 18, 2019
Merged

Fix README Build Status #16183

merged 3 commits into from
Sep 18, 2019

Conversation

zachgk
Copy link
Contributor

@zachgk zachgk commented Sep 16, 2019

Description

We display a build status at the top of the README between the mxnet logo and the Portable, Efficient, Scalable graphics. It is currently broken due to splitting the CI validation into multiple steps. This PR displays a build status for each of the steps as I don't know if Jenkins has a combined view.

Old Broken - https://github.com/apache/incubator-mxnet/blob/2a55cd7d1801e6ed801057cac9018b707fe3e27f/README.md
New 1 - https://github.com/zachgk/incubator-mxnet/blob/c62becbc73d74ae066fb1857a7aa3140a38bfb07/README.md
New 2 - https://github.com/zachgk/incubator-mxnet/blob/de80f2a0e27fc7af7489d0cb8fd2d3f190854d89/README.md

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

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

Check the preview... each button doesn't have any text with it, so it just a bunch of unlabeled badges.
https://github.com/apache/incubator-mxnet/blob/c62becbc73d74ae066fb1857a7aa3140a38bfb07/README.md

@zachgk
Copy link
Contributor Author

zachgk commented Sep 16, 2019

@szha szha merged commit 995b477 into apache:master Sep 18, 2019
larroy pushed a commit to larroy/mxnet that referenced this pull request Sep 28, 2019
* Fix README Build Status

* Add labels to Jenkins Badges

* Add more line breaks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants