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

[WIP] Issue-181 | Prepare for summer school release #182

Merged
merged 11 commits into from
Jun 27, 2022

Conversation

IceKhan13
Copy link
Member

@IceKhan13 IceKhan13 commented Apr 29, 2022

Summary

Prepare for summer school

TODOs:

  • workflow: release to PyPi on manual trigger
  • workflow: documentation release
  • requirements update
  • contribution guidelines fix
  • about project
  • beginners guide

@IceKhan13 IceKhan13 added the Changelog: None Do not include in changelog label Apr 29, 2022
@IceKhan13 IceKhan13 added this to the Summer school milestone Apr 29, 2022
@IceKhan13 IceKhan13 requested a review from a user April 29, 2022 19:33
@IceKhan13 IceKhan13 self-assigned this Apr 29, 2022
@IceKhan13 IceKhan13 added the WIP work in progress label Apr 29, 2022
@IceKhan13 IceKhan13 changed the title Issue-181 | Prepare for release cycles [WIP] Issue-181 | Prepare for release cycles Apr 29, 2022
@IceKhan13 IceKhan13 changed the title [WIP] Issue-181 | Prepare for release cycles Issue-181 | Prepare for release cycles Apr 29, 2022
@IceKhan13 IceKhan13 removed the WIP work in progress label Apr 29, 2022
Copy link

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

After this merges I'll populate the secrets for gha so that we'll be able to publish artifacts when it comes time to actually release.

TWINE_USERNAME: qiskit
run : |
pip install -U twine pip setuptools virtualenv wheel
python3 setup.py sdist bdist_wheel

Choose a reason for hiding this comment

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

Since there is a c++ extension in the package this won't be portable and isn't something you should publish as it will depend on the system libraries versions. You should leverage cibuildwheel here to build portable wheels of the package for distribution.

Copy link
Member Author

Choose a reason for hiding this comment

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

@mtreinish How do we test different distros for aer for example?

Choose a reason for hiding this comment

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

You don't really have to test with different distros in CI, that's what cibuildwheel is for. It builds the binaries in the manylinux docker image to ensure the glibc and other libraries are at old enough versions (by basically just using red hat which is always the oldest) and then auditwheel is used to statically link any dynamic libs and check the symbols are compatible with the manylinux packaging specs and update the wheel tags. If you configure cibiuldwheel correctly and have it run tests of the wheels it should be sufficient to have confidence it will work in any environment that is compatible with the manylinux tags

# Push to qiskit.org website
openssl aes-256-cbc -K $encrypted_rclone_key -iv $encrypted_rclone_iv -in tools/rclone.conf.enc -out $RCLONE_CONFIG_PATH -d
echo "Pushing built docs to website"
rclone sync --progress --exclude locale/** ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/qec

Choose a reason for hiding this comment

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

You will need to update https://github.com/Qiskit/qiskit/blob/master/tools/other-builds.txt so that qiskit doc builds won't delete the qec docs.

@mtreinish
Copy link

Also you should check the requirements list before release too. I noticed that retworkx isn't in the list but it is imported in the code directly. Every external package imported by qiskit-qec should be explicitly listed in the requirements list.

@IceKhan13 IceKhan13 added the WIP work in progress label Apr 29, 2022
@IceKhan13 IceKhan13 changed the title Issue-181 | Prepare for release cycles [WIP] Issue-181 | Prepare for release cycles Apr 29, 2022
requirements.txt Outdated Show resolved Hide resolved
@ghost
Copy link

ghost commented May 4, 2022

The docs/beginners_guide.md linked in the README (2. [Beginner's Guide](./docs/beginners_guide.md)) is empty? Is that supposed to be deleted/not in the README before we release?

@IceKhan13 IceKhan13 changed the title [WIP] Issue-181 | Prepare for release cycles [WIP] Issue-181 | Prepare for summer school release Jun 27, 2022
@IceKhan13
Copy link
Member Author

This issue is repurposed to prep works for summer school.

@IceKhan13 IceKhan13 merged commit 547589e into main Jun 27, 2022
@IceKhan13 IceKhan13 deleted the issue-181/prep-for-release-cycles branch June 27, 2022 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog WIP work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants