Skip to content

Conversation

@dbroemmel
Copy link

Checklist

  • Code follows the contributing guidelines of the project
  • This PR solves an existing issue and provided solution was discussed
  • The fix has been locally tested
  • Code follows the project's coding standards
  • Unit tests covering the new feature have been added
  • All existing tests pass
  • The documentation has been updated to reflect the new feature

List of related issues or pull requests

Briefly describe the changes made in this pull request

Next to READMEs as source for displayed badges, a GitLab-API call will obtain a list of project badges in case the platform is 'GitLab'. The current badge for howfairis will be compared to badges in both sources for badges, recommendations on what to change/update hopefully cover all combinations.

Two test cases have been amended/extended to cover at least the basics.

Additional Notes

No documentation has been changed, I guess more tests could be added as well.

Instructions to review the pull request

# make a new temporary directory and cd into it
cd $(mktemp -d --tmpdir howfairis.XXXXXX)

# get a copy of the repo
git clone https://github.com/fair-software/howfairis .

# checkout the work from this branch 
git checkout <this branch>

# create a virtual environment named venv3
python3 -m venv venv3

# activate the virtual environment
source venv3/bin/activate

# update pip and friends
python3 -m pip install --upgrade pip wheel setuptools

# install runtime dependencies
python3 -m pip install .

# and, if you need it, the development tools
python3 -m pip install .[dev]

Keep what you need from below, extend as necessary

# run the unit tests
pytest

# tests against a live infrastructure
pytest livetests/

GitLab supports including badges within the project settings, outside
any README files. GitLab also has an API call to get a collection of all
badges. This commit adds this API call and returned json blob to be
checked for badges apart from the README files. This should not affect
any github projects.
Adding a check for GitLab project badges opens up many different
possibilities where/how to check for the howfairis badge, trying to
cover what comes to mind. This commit also adds a single test for one
such case (would all have to be covered?).
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.

1 participant