Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifying the release schedule #355

Closed
gnikonorov opened this issue Oct 22, 2020 · 17 comments
Closed

Clarifying the release schedule #355

gnikonorov opened this issue Oct 22, 2020 · 17 comments
Labels
docs This issue/PR relates to or includes documentation. Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. ) packaging Packaging category

Comments

@gnikonorov
Copy link
Member

Hi everyone.

I think it may make sense to create a release schedule. I looked at PyPI and it looks like we haven't released a new version of this plugin since March of this year.

While we're at it, perhaps it would make sense to automate the process as much as possible and create a RELEASING.rst doc similar to pytest's. This way users could be aware of what to expect in terms of feature delivery.

Thoughts @ssbarnea @BeyondEvil @davehunt ?

@gnikonorov gnikonorov added docs This issue/PR relates to or includes documentation. packaging Packaging category Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. ) labels Oct 22, 2020
@BeyondEvil
Copy link
Contributor

BeyondEvil commented Oct 22, 2020

I'm no fan of release schedules for relatively small projects. They make sense for larger projects that have a roadmap.

As for "automatic" releases, I highly recommend Semantic Release we use it heavily at work (and it's not only for npm projects).

Easy to enforce in PRs using this Github app.

@gnikonorov
Copy link
Member Author

I'm no fan of release schedules for relatively small projects. They make sense for larger projects that have a roadmap.

You're right. It probably doesn't make sense for this plugin now that I think about it.

As for "automatic" releases, I highly recommend Semantic Release we use it heavily at work (and it's not only for npm projects).

This looks awesome! So it would be part of our pipeline, and then a separate step could publish the build product to PyPI right?

Also, can we publish a package now in the meantime since it's been a while and the changelog has a few unreleased items in it? I would do it, but I don't think I have the permission to.

@BeyondEvil
Copy link
Contributor

As for "automatic" releases, I highly recommend Semantic Release we use it heavily at work (and it's not only for npm projects).

This looks awesome! So it would be part of our pipeline, and then a separate step could publish the build product to PyPI right?

So, high level, this is how it works:

On every merge to the default branch (in our case master) Semantic Release is run. If it determines a release can be made (by scanning all the commits since last tag) it will create and push a new tag.

This tag will then trigger a workflow which publishes a package to PyPi.

Since I have experience with this, I'm happy to set it up if it makes sense to you and @ssbarnea.

Also, can we publish a package now in the meantime since it's been a while and the changelog has a few unreleased items in it? I would do it, but I don't think I have the permission to.

Sure! You can follow the steps here and I help you if you get stuck. 👍

@gnikonorov
Copy link
Member Author

Sure! You can follow the steps here and I help you if you get stuck. 👍

Thanks @BeyondEvil ! This weekend I'm going to submit a PR to release 3.0.0 then. We need a major bump because of #347. Does anyone have any objections?

@BeyondEvil
Copy link
Contributor

Sounds good @gnikonorov 👍

@gnikonorov
Copy link
Member Author

I think it makes sense to wait for #360 to merge before we release so we can test the new release workflow

@gnikonorov

This comment has been minimized.

@gnikonorov
Copy link
Member Author

I want to try and get a release out this weekend

@ssbarnea, @BeyondEvil did you want to wait for #361 before we release. Or do we want to go ahead regardless of the status of the PR

@ssbarnea
Copy link
Member

ssbarnea commented Nov 7, 2020

On community maintained open-source project a "schedule" is unrealistic. I can be today, slip to next month or never, based on who needs it more. There is no value in documenting something that nobody can follow.

Yep, I was waiting for the other patches merged before tagging a new pre-release. Pre-release are cheap and safe to make because users do not get access to them unless they specify the version explicitly or use the --pre argument on pip.

@gnikonorov
Copy link
Member Author

gnikonorov commented Nov 8, 2020

@ssbarnea can we do a release now instead of waiting? We haven't released since March and we have unreleased bug fixes that I would like to release if possible.

@BeyondEvil
Copy link
Contributor

Go head and start on a release @gnikonorov 👍

@gnikonorov
Copy link
Member Author

Go head and start on a release @gnikonorov 👍

Thank you @BeyondEvil ! I'll do the release this weekend

@gnikonorov
Copy link
Member Author

gnikonorov commented Nov 13, 2020

Mentioning that I'll release 3.0.0 tomorrow evening EST

I'll be following the process outlined here: https://github.com/pytest-dev/pytest-html/blob/master/development.rst#releasing-a-new-version

@ssbarnea @BeyondEvil

@BeyondEvil
Copy link
Contributor

Mentioning that I'll release 3.0.0 tomorrow evening EST

I'll be following the process outlined here: https://github.com/pytest-dev/pytest-html/blob/master/development.rst#releasing-a-new-version

@ssbarnea @BeyondEvil

I'm not sure if that process needs updating now that we have the release-drafter? @ssbarnea

@gnikonorov
Copy link
Member Author

I'm not sure if that process needs updating now that we have the release-drafter? @ssbarnea

I'd also strongly prefer release without the release drafter changes if they need more work so we're not blocked.

@BeyondEvil
Copy link
Contributor

I'm not sure if that process needs updating now that we have the release-drafter? @ssbarnea

I'd also strongly prefer release without the release drafter changes if they need more work so we're not blocked.

Good point! 👍

@gnikonorov
Copy link
Member Author

v3.0.0 is out, @ssbarnea @BeyondEvil

Closing this then. Since it seems like we'll just do adhoc releases as we need them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue/PR relates to or includes documentation. Infrastructure Changes related to project infrastructure ( CI/CD, deploy mechanism, etc. ) packaging Packaging category
Projects
None yet
Development

No branches or pull requests

3 participants