Actions

[JoelLefkowitz]

As mentioned in #739 Travis CI is no longer running CI for free. This PR allows Github actions to run unit tests. This will allow us to continue approving PRs.

The tox environments for linters, djmaster and docs have been bound to explicit python versions rather than rely on CI environment variables for this.

The djmaster testenv until now has been allowed to fail. This is now made explicit with a tox flag. It is still a useful check as it offers diagnostic information about future compatibility.

[JoelLefkowitz]

I would like approval from at least one more frequent contributor before changing over the required checks settings.

[johnthagen]

@JoelLefkowitz I left a few comments, but in general thank you for putting the time into this. This looks great.

[JoelLefkowitz]

I think only @axnsan12 has permission to remove the travis status check and set the github actions ones to be required.

[johnthagen]

In the case that @axnsan12 has this repo muted (understandable given he's mentioned he's moved on to other things), his email address can be viewed in the commit log: https://github.com/axnsan12/drf-yasg/commit/a9ec562196a697c2fbfa16ad741f53831b8ab654.patch

Might be a way to get into contact with him.

[axnsan12]

Hello, I do indeed have the repo muted 😢 but I do check on the notifications from time to time.

From what I see Travis still offers CI credits for open source projects: https://docs.travis-ci.com/user/billing-faq/#what-if-i-am-building-open-source

I could write to them to request this for drf-yasg and see how it goes.

Or, if you'd prefer to switch to actions, I can remove the Travis check and be done with it.

[johnthagen]

@axnsan12 I personally think that GitHub Actions is the way forward. Most open source projects I've worked on have switched, and it's been a net benefit for the project (faster CI, the marketplace helps avoid boilerplate, etc.).

And since @JoelLefkowitz has done the hard work getting the configs switched over, I think it would be the best path forward for drf-yasg.

Or, if you'd prefer to switch to actions, I can remove the Travis check and be done with it.

I also think that if we go this path, along with removing the Travis checked, adding the GitHub Actions checks as required would also be a good move.

[axnsan12]

I think I removed the Travis check however it doesn't seem to apply retroactively...
The actions checks, like all checks that run on PRs, are required by default.

[axnsan12]

I hope you don't mind if I force merge this and see what happens.

[johnthagen]

The actions checks, like all checks that run on PRs, are required by default.

I don't think this is correct. The checks will show up in the PR, but if they are not required, then someone with merge rights to the repo can still merge even if the GitHub Actions checks fail.

[axnsan12]

Seems the Travis removal worked 🎉 , thanks for the PR!

Looks like the GitHub ones are now required too: #730

[axnsan12]

I've also set up the PYPI_API_TOKEN secret required by the publish job.

[JoelLefkowitz]

Thanks for changing the settings @axnsan12. I'm going to label the recent bugs reported while the CI was down for a 1.20.1 release. What do you think about giving one of the frequent collaborators admin access to the repo? That way we can respond to these type of unforeseen support changes.

[johnthagen]

Given @JoelLefkowitz's commitment to the project, for what it's worth I would nominate he be given admin access if @axnsan12 concurs.

[axnsan12]

I'm not sure that's possible on a personal repo, we'd have to make an organisation to be able to have multiple owners.

Personal repos can only add "collaborators" - which both of you are.

[johnthagen]

@JoelLefkowitz Since you were talking about cutting a new release, it probably wouldn't hurt to also update the bundled swagger-ui / redoc that is included in this project:

• https://github.com/axnsan12/drf-yasg/tree/master/src/drf_yasg/static/drf-yasg

drf-yasg/package.json

Lines 4 to 5 in effc8f2

	"redoc": "^2.0.0-rc.40",
	"swagger-ui-dist": "^3.36.0"

[tfranzel]

@axnsan12 @johnthagen, I had to migrate from travis-ci.org to travis-ci.com a while ago, because the builds simply stopped working.

They do provide credits for OSS, but it's a painful process. You have to write a support ticket and and apply for OSS credits. That works fairly fast, but they only credit X amount at a time. Since migrating, I had to re-request credit 4-5 times. Multiple questions regarding a recurring "monthly allowance" were ignored.

[axnsan12]

Thanks for the info, but we decided to just ditch Travis in the end. Seems like that was the right choice, your experience sure does sound like a lot of hassle 😄