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 info badges to readme #72

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Conversation

LucaMingarelli
Copy link

No description provided.

@mortada
Copy link
Owner

mortada commented Apr 30, 2024

looks cool! thanks!

@mortada mortada merged commit 3114aac into mortada:master Apr 30, 2024
2 checks passed
@@ -1,6 +1,11 @@

# fredapi: Python API for FRED (Federal Reserve Economic Data)

[![Build and test GitHub](https://github.com/mortada/fredapi/actions/workflows/main.yml/badge.svg)](https://github.com/mortada/fredapi/actions)
[![version](https://img.shields.io/badge/version-0.5.1-success.svg)](#)
Copy link
Owner

Choose a reason for hiding this comment

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

just realized this is actually hardcoded to 0.5.1, any idea how to update this, or maybe this should be removed because the latest release is already shown by the line below? thanks!

Copy link
Owner

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

@mortada : ideally they would always show the same version, but they relate to different things: the former is the version on github, the second is the version actually published on pypi. If they differ they serve as a reminder that the latest version available has not been published yet.

One option is of course to update the badge manually, however this master...LucaMingarelli:fredapi:patch-1 can also be used within the workflow to have it done automatically.

It needs to be called from the main.yml like so:
master...LucaMingarelli:fredapi:patch-2

Copy link
Author

Choose a reason for hiding this comment

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

Uff, there's a typo on this master...LucaMingarelli:fredapi:patch-1: line 25 should be f.write(README_NEW) ...

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.

2 participants