Skip to content

docs: fix dead badges and stale install instructions in README - #870

Open
mmilanovic4 wants to merge 1 commit into
Netflix:masterfrom
mmilanovic4:fix/readme-badges
Open

mmilanovic4 wants to merge 1 commit into
Netflix:masterfrom
mmilanovic4:fix/readme-badges

Conversation

@mmilanovic4

Copy link
Copy Markdown

Fixes #718.

Badges

Both badges reported in #718 are dead:

  • Build Status pointed at travis-ci.com/Netflix/hollow, which 404s. CI for
    this repo runs through .github/workflows/nebula-ci.yml, so the badge now
    points there.
  • Download pointed at api.bintray.com. Bintray was shut down in 2021 and
    the image no longer renders. Replaced with a Maven Central badge, which tracks
    the published version on its own rather than needing a bump.

Install instructions

The surrounding text in the same section had drifted as well, so this includes
the smallest set of fixes that makes it correct:

  • The version table and both snippets pinned 5.1.3. The most recent release
    tag in this repo is v7.15.3, so I used that.
  • The Gradle snippet used compile, which Gradle 7 removed. Copying it into a
    current build fails, so it is now implementation.
  • Dropped the mention of jCenter, which no longer exists.

Testing

Documentation only.

travis-ci.com 404s for this repo and Bintray was shut down in 2021, so
both badges render nothing. Point them at the nebula-ci.yml workflow and
Maven Central instead. The install snippets in the same section had also
drifted: 5.1.3 against a latest tag of v7.15.3, and a `compile`
configuration that Gradle 7 removed.

Fix Netflix#718

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken Build Status and Download Badges in README

1 participant