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

release a v0.12 before dropping jquery #1042

Closed
15 tasks done
12rambau opened this issue Oct 27, 2022 · 6 comments
Closed
15 tasks done

release a v0.12 before dropping jquery #1042

12rambau opened this issue Oct 27, 2022 · 6 comments

Comments

@12rambau
Copy link
Collaborator

12rambau commented Oct 27, 2022

as mentioned in #1025 dropping jquery and bootstrap 4 is a big update that may break many downstream pipeline. before releasing it let's make a patch to v0.11 to see if user have anything to report.

These steps should be taken in order to create a new release!1
Double check for quality-control

Prepare the codebase for a new version

  • Bump __version__ in __init__.py2
  • Update our version switcher .json file with the new version
  • Make a release commit: git commit -m 'RLS: v0.11.1'
  • Push the RLS commit git push upstream main
  • If a release candidate is needed, tick this box when we're now ready for a full release.

Make the release

  • Start a new GitHub release
  • Call the release the current version, e.g. v0.2.0
  • In the Choose a Tag: dropdown, type in the release name (e.g., v0.2.0) and click "Create new tag"
  • In the Target: dropdown, pin it to the release commit that you've just pushed.
  • Add release notes in the field below (if it's a minor/major version bump)3
  • Confirm that the publish github action job has completed successfully in the actions tab
  • Confirm that the PyPI version is updated
  • Celebrate, you're done!

Footnotes

  1. Taken from the release checklist in our wiki. See the release documentation for an overview of release processes.

  2. Use semantic versioning to decide whether it's a major, minor, or patch bump. Before we have released 1.0, treat minor versions as breaking releases, and patch versions as feature / patch releases. If this is a release candidate, tag it like 0.1rc1.

  3. If you wish, use github-activity to generate a changelog, eg github-activity pydata/pydata-sphinx-theme --since v0.2.2 --until v0.3.0.

@jarrodmillman
Copy link
Collaborator

Why not just release main as v0.12 and merge #1029 after that release? There are a few improvements on the main branch as is. If we do a 0.11.1 release, we should go through the merged PRs and decide which ones are just bug fixes and documentation updates.

If we decide to release main as v0.12, I can make a rc1 this weekend. If we want to make a bugfix release, I can sort through the changes to main and figure out which ones belong in a v0.11.1 release.

Either way, I think making a release before merging #1029 is a great idea.

@12rambau 12rambau changed the title release a v0.11.1 before dropping jquery release a v0.12 before dropping jquery Nov 8, 2022
@choldgraf choldgraf added this to the 0.11.1 milestone Nov 9, 2022
@choldgraf
Copy link
Collaborator

I created a v0.11.1 milestone, but agree that it's fine to just release this as v0.12 if we like, and then the JQuery / Bootstrap changes can be in v0.13.

Either way, I am +1 on getting a release out ASAP!

@12rambau
Copy link
Collaborator Author

12rambau commented Nov 9, 2022

we still have 1 blocking issue and it will be good to go

@12rambau
Copy link
Collaborator Author

v0.12.0rc1 is out, let's see how people react

@12rambau 12rambau removed this from the 0.11.1 milestone Nov 10, 2022
@12rambau
Copy link
Collaborator Author

@choldgraf and @jarrodmillman how long should I wait for feedbacks before sending 0.12.0 ?

@choldgraf
Copy link
Collaborator

I'm happy to follow whatever you prefer @12rambau - but I'd recommend about 3-5 days to give others a chance to install.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants