Implement Jazzband guidelines for django-invitations

[jazzband-bot]

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

It was initiated by @bee-keeper 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-invitations/collaboration/)
• [x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-invitations/users/)
• [x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-invitations/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	Generic invitations app for Django
Homepage
Stargazers	362
Open issues	44
Forks	140
Default branch	master
Is a fork	False
Has Wiki	True
Has Pages	False

[MrCordeiro]

@valberg, please stop accepting PRs that don't pass the testing workflow

[valberg]

@MrCordeiro They do pass the testing flow if we merge in https://github.com/jazzband/django-invitations/pull/174 :)

[valberg]

I have just created a Read the Docs project: https://readthedocs.org/projects/django-invitations/ and added jazzband-bot as maintainer.

[valberg]

Hey @bee-keeper

When you get the time it would be great if you could "Add jazzband account to PyPI project as maintainer role" as per the checklist above :)

[valberg]

@bee-keeper ping about the above :)

[LukasKlement]

Do you have an ETA for the next release? Django 4 is out for a while now, and this package is still not compatible.

[valberg]

@LukasKlement no, there is no ETA. When we get the pypi maintainer role assigned to the jazzband account things should start rolling.

For now I can recommend that you use the latest git sha

[valberg]

@bee-keeper Sorry to ping you again - but I think the last thing we need is to "Add jazzband account to PyPI project as maintainer role". Let me know if I can help with anything.

[valberg]

@bee-keeper Ping :)

[bee-keeper]

Hi, have you some instruction to do this? is it just an email?

[MrCordeiro]

@bee-keeper, you have to go to the project's page on PyPI (https://pypi.org/manage/project/django-invitations/collaboration), where you are currently the sole maintainer, and add the jazzband user (https://pypi.org/user/jazzband/) to the project. That way, the bot can send any new package release to PyPI.

Only the current owners of a project have the ability to add new owners or maintainers.

[bee-keeper]

@MrCordeiro ok done, thanks

[MrCordeiro]

Awesome!

@valberg, there's a CI workflow for project releases, but I think that if you create a new release with the latest changes now it will return a 500 error until the release key is added to the Repo's secrets (at least this was what happened here).

After that's done, the release workflow should send the project lead(s) and roadie an email to release the new version to PyPi.

And then' it's done!

[valberg]

Great! I'm guessing that adding the release key is not something I can do? If so, got any pointers @MrCordeiro ?

Btw. I do not have access to "settings" (https://github.com/jazzband/django-invitations/settings) - but I guess that is by design @jezdez ?

[Natureshadow]

Can we please either get this done, or make a release as it was done before? As it stands, Jazzband is currently preventing proper maintenance instead of helping it.

[valberg]

@jezdez @MrCordeiro I'm kinda blocked here - could you guide me in the right direction?

[MrCordeiro]

@valberg, if the release workflow is not working, I believe you need @jezdez to set the JAZZBAND_RELEASE_KEY (yes, we don't have access to the settings, but it's by design).

Not sure whether you can tick the last box yet or if you need to open a ticket first. I can interpret the bot's TODOs both ways.

Edit: just editing this to say that I appreciate the time you're investing in this @valberg (o゜▽゜)o ☆ !

[valberg]

I just tried to release 2.0.0 - but it failed: https://github.com/jazzband/django-invitations/actions/runs/3141681027/jobs/5104396248

Any ideas @MrCordeiro @jezdez ?

[jezdez]

Hey all, sorry for the slow response, I've just added the JAZZBAND_RELEASE_KEY to the repo and this should be good to go.

@valberg and @brylie Please make sure to read https://jazzband.co/about/releases, https://jazzband.co/about/guidelines and https://jazzband.co/about/faq. I've restarted the 2.0.0 release action.

[jezdez]

Oh bummer, turns out https://github.com/jazzband/django-invitations/pull/179/files#r982067309 basically broke the release workflow and doesn't actually publish to the Jazzband index and just configures it. This is independent of the lack of secret key above though. Please request a code review if you change the release workflow the next time.

[jezdez]

I've opened https://github.com/jazzband/django-invitations/pull/195 to fix it.

[jezdez]

As the next steps:

• [x] get #195 merged
• [x] delete 2.0.0 tag
• [x] create a new 2.0.0 tag, which triggers the release workflow and uploads it to the Jazzband package index
• [x] @valberg and @brylie then get emails to their verified email addresses, requesting to verify and confirm the release via the website, just follow the instructions in the email. This is done to prevent malicious releases as anyone can create git tag in Jazzband
• [x] close this ticket (I think?)
• celebrate 🥳

[valberg]

@brylie I guess we have to update the version in pyproject.toml to get the correct release build on jazzband.co - right now it is building 2.0.0. Do you wish to do it?

[brylie]

I will be AFK for a while, but I am available to approve a PR via my phone. Would you bump the release version?

[valberg]

@brylie I opted for removing the tags/releases and stick to 2.0.0 :)

[valberg]

There we go! 2.0.0 is out! https://pypi.org/project/django-invitations/

[valberg]

Thanks of all the work @bee-keeper @jezdez @MrCordeiro @brylie