Implement Jazzband guidelines for django-rest-framework-simplejwt
jazzband-bot opened this issue · 26 comments
This issue tracks the implementation of the Jazzband guidelines for the project django-rest-framework-simplejwt
It was initiated by @davesque 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
- Fix all links in the docs (and README file etc) from old to new repo
- Add the Jazzband badge to the
READMEfile - Add the Jazzband contributing guideline to the
CONTRIBUTING.mdorCONTRIBUTING.rstfile - Port continuous testing to GitHub Actions (away from Circle, see previous migrations in https://github.com/orgs/jazzband/projects/1)
- Check if test coverage services work (must be Codecov, etc)
- Add
jazzbandaccount to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/django-rest-framework-simplejwt/collaboration/) - Add
jazzband-botas maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-rest-framework-simplejwt/users/) - Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-rest-framework-simplejwt/integrations/)
- Fix project URL in GitHub project description
- Review project if other services are used and port them to Jazzband
- Decide who is project lead for the project (if at all) (@davesque and @Andrew-Chen-Wang)
- Set up CI for Jazzband project releases if needed and open ticket if yes
Project details
| Description | A JSON Web Token authentication plugin for the Django REST Framework. |
| Homepage | https://django-rest-framework-simplejwt.readthedocs.io/ |
| Stargazers | 2236 |
| Open issues | 81 |
| Forks | 351 |
| Default branch | master |
| Is a fork | False |
| Has Wiki | True |
| Has Pages | False |
Hi @davesque! Welcome to Jazzband, please make sure to follow the Jazzband guidelines and implement the above items as soon as possible. If you have any question, please let me know.
@auvipy Hey we chatted through e-mail. Do you have time to do this checklist? I transferred this repo to jazzband because I don't have any spare moments for things like this.
Hey @jezdez. Thanks for the welcome! Hopefully having this project in jazzband will help to keep it alive. I recognize that I've been so distracted that it's been a disservice to the community of users that depend on this project. So it's nice that there are things like jazzband.
@auvipy Do you mind going to codecov to set the GitHub secret for CODECOV_TOKEN. I don't have perms to access the settings.
#397 should check off "Port continuous testing to GitHub Actions"
@jezdez can you clarify by what "Set up CI for Jazzband project releases if needed and open ticket if yes" means? As in GitHub projects or regular PyPi releases? If the latter, that's already in the GitHub workflows (albeit untested I think until we get 4.7.0 out soon...).
@auvipy I would definitely appreciate if you removed branch protection rules for me... not able to actually merge anything to master.
Hey @Andrew-Chen-Wang, thanks for working on the GHA updates in #397, this is super appreciated. I've updated some of your changes to better follow the practices we've seen work well in other Jazzband projects but your work has been very useful.
I've updated all the TODO items above that have been done I think, the biggest one is to decide who'll be the project leads to be able to do PyPI releases via the Jazzband package index.
@davesque Other than @Andrew-Chen-Wang who did you have in mind as project leads? (I've made you two leads now: https://jazzband.co/projects/django-rest-framework-simplejwt
By the way, thanks to @Andrew-Chen-Wang I was able to disable Circle CI for the whole Jazzband organization, which was a big liability. Thank you! <3
FYI I renamed the repo to match the project name on PyPI to djangorestframework-simplejwt since that simplifies maintenance and the release process a notch.
@jezdez sorry to bother again. I tried pushing out a release from the GitHub UI, but the action simply failed? I can rollback the tag and push a new commit, but I'm unable to commit directly to master and I'm also not allowed to merge my own PRs since I can't approve my own PRs via GitHub reviews. Anyhow, priority is working out why the release workflow isn't working.
@jezdez sorry to bother again. I tried pushing out a release from the GitHub UI, but the action simply failed? I can rollback the tag and push a new commit, but I'm unable to commit directly to master and I'm also not allowed to merge my own PRs since I can't approve my own PRs via GitHub reviews. Anyhow, priority is working out why the release workflow isn't working.
Ah yeah, I simply forgot to update the release workflow with the new name, fixed in 2591942. I've also went ahead and did a few more items from the TODO list above that should have happened before you tried a release.
Since @davesque hasn't responded to my comment above who else should become project lead I'm going to keep @Andrew-Chen-Wang and @davesque as project leads for now. Feel free to open a new issue about adding more project leads.
@Andrew-Chen-Wang I've deleted the Git tag and the GitHub release automatically reverts to being a draft release. If you publish the release with the current master it should simply trigger a new release workflow. Remember that you'll receive an email from the Jazzband package index afterwards (to your verified GitHub email address) to confirm the release to PyPI. Let me know if you have any questions.
@Andrew-Chen-Wang Ironically GitHub Actions seemed to have had stability issues yesterday and this repo was affected as well. I'm sorry for the issue
No problem. Is #406 still needed in this case?
No problem. Is #406 still needed in this case?
Yeah, totally, good catch! I've also deleted the tag again, try again?
Yea! Running right now!
Arg it might've skipped the release mechanism because the commit might've skipped the CI... Not entirely sure if that's correct though.
Arg it might've skipped the release mechanism because the commit might've skipped the CI... Not entirely sure if that's correct though.
Oh lol, no problem! Want to push a new commit and re-add the tag? (just deleted it)
I can't. I don't have the perms to commit directly to master nor can I approve my own PRs.
I can't. I don't have the perms to commit directly to master nor can I approve my own PRs.
Right, that's by design, I should have been more clear saying to push a commit to a non-protected branch, open a PR and assign me for code review so I can approve it.
@jezdez ah no problem. I'll open one right now.
v4.7.0 source and wheel is released and it seems like everything here is done so I'll close this now.
@Andrew-Chen-Wang Huzzah!
thanks for helping @jezdez !
Thanks for doing all this, guys!