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

Added auto version bump functionality to pl lightning #159

Merged
merged 5 commits into from
Nov 2, 2021
Merged

Conversation

Jaybsoni
Copy link
Contributor

@Jaybsoni Jaybsoni commented Nov 1, 2021

Context:

  • Automated version bumping of the lightning plugin

Description of the Change:

  • added a two new GitHub workflows to bump the version # on release

@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2021

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

title: Version Bump
body: updated changelog and _version.py
branch: post-release-version-bump
reviewers: Jaybsoni
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will change this to whom ever this plugin is assigned to as a reviewer

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to add me here, ccing @mlxd too: Jay is adding an automated version bump for the pre and post-release of Lightning. The new actions would tidy the changelog and increment the version number. For now, the action opens a new PR and this field determines who'll be put as the reviewer(s) to the PR. Would you also like to be tagged? 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
reviewers: Jaybsoni
reviewers: antalszava

@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2021

Test Report (C++) on Ubuntu

       1 files  ±0         1 suites  ±0   0s ⏱️ ±0s
   327 tests ±0     327 ✔️ ±0  0 💤 ±0  0 ±0 
1 185 runs  ±0  1 185 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit c735d22. ± Comparison against base commit bbab558.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great overall 💯 Just one comment regarding pl_release_status.

title: Version Bump
body: updated changelog and _version.py
branch: post-release-version-bump
reviewers: Jaybsoni
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to add me here, ccing @mlxd too: Jay is adding an automated version bump for the pre and post-release of Lightning. The new actions would tidy the changelog and increment the version number. For now, the action opens a new PR and this field determines who'll be put as the reviewer(s) to the PR. Would you also like to be tagged? 🙂

Comment on lines 29 to 30
pl_release (bool): A flag which determines if the new
version of PennyLane has already been released to Pypi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely, we could do without this option. For the pre-release version bump, there will likely not be a scenario where we have

a) not done the pre-release version bump;
b) have released PennyLane.

Where there's a minor difference in the case of Lightning, is the post-release version bump: we'll likely be releasing PennyLane-Lightning first and then PennyLane. If the opposite order was assumed and used somewhere, then we'd need a change in logic there.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh I see. Currently it can support performing both pre or post release version bumps both before or after we have released Pennylane. I can remove this flag as for post-release version bumps I do not use the current version of PL, but instead just increment the version found in the change log and _version.py file. My personal recommendation would be to keep it in as this kind of functionality might become useful if in the future we decide to change up when we are going to be releasing some of the plugins.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's not used at the moment, then maybe it's best to remove it. It can lead to confusion to have an option that is not needed.

@codecov
Copy link

codecov bot commented Nov 2, 2021

Codecov Report

Merging #159 (c735d22) into master (bbab558) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #159   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          182       182           
=========================================
  Hits           182       182           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bbab558...c735d22. Read the comment docs.

Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 💯

@mlxd
Copy link
Member

mlxd commented Nov 2, 2021

Nice work putting this together --- I don't see any issues on merging!

@Jaybsoni Jaybsoni merged commit 1ac6b8b into master Nov 2, 2021
@Jaybsoni Jaybsoni deleted the auto_vb branch November 2, 2021 16:36
@antalszava
Copy link
Contributor

[sc-10712]

antalszava added a commit that referenced this pull request Nov 3, 2021
* Added auto version bump functionality to pl lightning (#159)

* Added auto version bump functionality to pl lightning

* Update .github/workflows/pre_release_version_bump.yml

removed trailing white space

* Update .github/workflows/post_release_version_bump.yml

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* Update .github/workflows/pre_release_version_bump.yml

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* removed flag for pennylane release as it is not required

Co-authored-by: antalszava <antalszava@gmail.com>

* Update pre_release_version_bump.yml (#160)

* Update pre_release_version_bump.yml

* Update pre_release_version_bump.yml

* Update pre_release_version_bump.yml

* Update .github/workflows/pre_release_version_bump.yml

* Apply suggestions from code review

* Update post_release_version_bump.yml

swap main --> master

* Update CHANGELOG.md

To be consistent with other plugins and not cause errors for the auto version bumping

* pre release version bump

* updates

* Update pennylane_lightning/_version.py

* formatting updates to changelog

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@users.noreply.github.com>
mlxd added a commit that referenced this pull request Nov 15, 2021
* Version Bump `0.19.0` (#163)

* Added auto version bump functionality to pl lightning (#159)

* Added auto version bump functionality to pl lightning

* Update .github/workflows/pre_release_version_bump.yml

removed trailing white space

* Update .github/workflows/post_release_version_bump.yml

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* Update .github/workflows/pre_release_version_bump.yml

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* removed flag for pennylane release as it is not required

Co-authored-by: antalszava <antalszava@gmail.com>

* Update pre_release_version_bump.yml (#160)

* Update pre_release_version_bump.yml

* Update pre_release_version_bump.yml

* Update pre_release_version_bump.yml

* Update .github/workflows/pre_release_version_bump.yml

* Apply suggestions from code review

* Update post_release_version_bump.yml

swap main --> master

* Update CHANGELOG.md

To be consistent with other plugins and not cause errors for the auto version bumping

* pre release version bump

* updates

* Update pennylane_lightning/_version.py

* formatting updates to changelog

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@users.noreply.github.com>

* Fix OpenMP library issues on M1 Macs (#166)

* Fix OMP issue on M1 macs

* Update changelog

* Fix CI builder release issues (#168)

* Fix OMP issue on M1 macs

* Update changelog

* Fix CI builder

* Trigger CI on release creation

* CI wheelbuilder updates (#169)

* Fix OMP with ARM MacOS

* Ensure wheels uploaded to GH

* Separate out noarch wheels

* Update .github/CHANGELOG.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

3 participants