Implement Jazzband guidelines for django-revproxy

jazzband-bot commented 3 years ago

This issue tracks the implementation of the Jazzband guidelines for the project django-revproxy

It was initiated by @brianmay who was automatically assigned in addition to the Jazzband roadies.

See the TODO list below for the generally required tasks, but feel free to update it in case the project requires it.

Feel free to ping a Jazzband roadie if you have any question.

TODOs

[x] Fix all links in the docs (and README file etc) from old to new repo
[x] Add the Jazzband badge to the README file
[x] Add the Jazzband contributing guideline to the CONTRIBUTING.md or CONTRIBUTING.rst file
[x] Check if continuous testing works with GitHub Actions
[x] Check if test coverage is tracked with Codecov
[x] Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/django-revproxy/collaboration/)
[x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-revproxy/users/)
[x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-revproxy/integrations/)
[x] Fix project URL in GitHub project description
[x] Review project if other services are used and port them to Jazzband
[x] Decide who is project lead for the project (if at all)
[x] Set up CI for Jazzband project releases if needed and open ticket if yes

Project details


Description	Reverse Proxy view that supports all HTTP methods, Diazo transformations and Single Sign-On.
Homepage
Stargazers	188
Open issues	31
Forks	74
Default branch	master
Is a fork	False
Has Wiki	True
Has Pages	False

brianmay commented 3 years ago

@thatsed @seocam This project was now been transferred...

brianmay commented 3 years ago

I think I setup all the accounts as required. PyPI still pending on invite being accepted. If I got something wrong, please let me know.

brianmay commented 3 years ago

CI is with travis, probably this needs to be converted to use github actions I think.

brianmay commented 3 years ago

There are a number of services listed here:

https://github.com/jazzband/django-revproxy/settings/hooks

I suspect I don't have access to many. Might just want to delete these.

readthedocs was not listed (huh?) - hoping I correctly added it.

jezdez commented 3 years ago

@brianmay Welcome and thanks for working on those items. I've accepted the PyPI invite and deleted the service hooks from the services we don't use for Jazzband projects.

thatsed commented 3 years ago

Unfortunately I lack the expertise to help setup GitHub Actions for the project, should we ask on the members' team if there's someone available to help with that?

brianmay commented 3 years ago

@thatsed Sounds good to me. This probably should be done (if possible) by somebody with experience with other JazzBand projects.

FernandoKGA commented 2 years ago

Hey @brianmay, could you tick both lines about the badge and CONTRIBUTING file (if the #139 PR is ok, of course)?

brianmay commented 2 years ago

Done

FernandoKGA commented 2 years ago

I will take a look into the first check that's related to the README, and check why the docs setup is failing to me (maybe I just messed up). @brianmay you're going to setup the Codecov pipeline? Or other maintainer will? (Your doc is working fine?)

brianmay commented 2 years ago

Not really sure how jazzband configures codecov, and don't have a lot of time to investigate. Might be better if somebody more experienced with Jazzband supplies the github CI.

andruten commented 2 years ago

README links have been updated and .github/workflow/release.yml has been created based on django-formtools ones but there is now a broken link related to tests:

.. image:: https://github.com/jazzband/django-revproxy/workflows/Test/badge.svg
   :target: https://github.com/jazzband/django-revproxy/actions
   :alt: GitHub Actions

Also added run section in .coveragerc

Upload coverage step says:

==> GitHub Actions detected.
    Env vars used:
      -> GITHUB_ACTIONS:    true
      -> GITHUB_HEAD_REF:   add-release-workflow
      -> GITHUB_REF:        refs/pull/154/merge
      -> GITHUB_REPOSITORY: jazzband/django-revproxy
      -> GITHUB_RUN_ID:     3409647564
      -> GITHUB_SHA:        fc417770cb2ca7edd5687f[29](https://github.com/jazzband/django-revproxy/actions/runs/3409647564/jobs/5681140262#step:8:30)1d0ab4114e1a6db9
      -> GITHUB_WORKFLOW:   Python package
    project root: .
    Yaml not found, that's ok! Learn more at http://docs.codecov.io/docs/codecov-yaml
==> Running gcov in . (disable via -X gcov)
==> Python coveragepy not found
==> Searching for coverage reports in:
    + .
--> No coverage report found.
    Please visit http://docs.codecov.io/docs/supported-languages

I've been trying to locate that yaml file in several jazzband repos but I couldn't find it.

Can you please check this? @brianmay @jezdez

brianmay commented 1 year ago

README links have been updated and .github/workflow/release.yml has been created based on django-formtools ones but there is now a broken link related to tests:

Does this help? https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge

Yaml not found, that's ok! Learn more at http://docs.codecov.io/docs/codecov-yaml

I am not familiar with any of this, but guessing you might need to create a new file from scratch using above instructions.

andruten commented 1 year ago

Thank you @brianmay. I've published a PR for solving the link :). https://github.com/jazzband/django-revproxy/pull/155

andruten commented 1 year ago

I think points 1, 4 and 5 can be marked as done. Am I right?

brianmay commented 1 year ago

Probably. Sounds good to me. Assume you can do it, otherwise let me know and I will do it.

andruten commented 1 year ago

I see them as read-only, sorry. Can you please update them?

What do you think about remaining tasks?

brianmay commented 1 year ago

Done.

Review project if other services are used and port them to Jazzband

Not really sure what this is asking.

Decide who is project lead for the project (if at all)

Needs somebody with time. Not me :-)

Set up CI for Jazzband project releases if needed and open ticket if yes

Not sure I understand. Maybe this was done?

andruten commented 1 year ago

I think first task is asking for updating related repositories which are linking the old repo url. Last task could be considered as done.

Anyway, I can publish some PRs in order to keep updated this library.

Drop python 2.7, 3.5 and 3.6
Add support for python 3.11
Add support for Django 4.0 and 4.1

andruten commented 1 year ago

Hi @jezdez! We've solved almost all tasks. There is a remaining issue related to publishing a release. It seems JAZZBAND_RELEASE_KEY is not set so release action is failing. I've opened an issue in the jazzband/help repository. Could you please help me? :)

andruten commented 1 year ago

I proposed myself as project lead. It may resolve all tasks. See https://github.com/jazzband/help/issues/333

mihalikv commented 1 year ago

@jezdez Can you please help with releasing a new version that is already in the master? Thanks.

jezdez commented 1 year ago

@andruten Done!

@mihalikv I've made @andruten project lead, he's the first person to get in touch with.

jezdez commented 1 year ago

Closing as I think all steps are done.

jazzband / django-revproxy

Implement Jazzband guidelines for django-revproxy #129

TODOs

Project details