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

Experiment with determining GitHub branch name - PR build #592

Closed
wants to merge 15 commits into from

Conversation

Eric-Arellano
Copy link
Collaborator

No description provided.

Eric-Arellano and others added 14 commits September 15, 2023 13:43
We use GitHub branch protection to require opening a PR for `main` and
the `1.*` branches; you cannot push directly. For `main`, we also
require that CI runs against the latest `main`.

So, there is no need to run CI again for pushes since it already runs
with PRs. Don't waste compute resources, which have a real environmental
cost.
This PR changes the wheel-build job to publish the package to PyPI with
the trusted publisher mechanism following the steps in
https://docs.pypi.org/trusted-publishers/using-a-publisher/ and
https://github.com/Qiskit/rustworkx/pull/1001/files
Closes #571. Thanks
to @arnaucasau, no projects are actively using the old Pytorch theme 🎉

A follow up will also remove the `qiskit` theme so that we only have
`qiskit-ecosystem`.
Qiskit documentation now lives in docs.quantum.ibm.com and has its own
analytics mechanism.

The Qiskit Ecosystem projects will be migrating to GitHub pages.
Qiskit/ecosystem#578. Given that, I doubt
we'll want to commit to still maintaining this analytics mechanism.
Maintenance is more than only the code: it also means committing to
helping projects access the dashboard.

Instead, keep this Sphinx theme as simple as possible to make it more
sustainable. Projects highly interested in analytics could always add
the functionality their own way.
The Qiskit theme is being removed and we'll only have qiskit-ecosystem,
per #577.

The qiskit-ecosystem theme never supported these custom announcements
from #530 - so this
current code adds unnecessary noise.

If we decide we do want this custom announcement feature for the
Ecosystem, we can always add this code back easily thanks to Git. In the
meantime, the focus is on making this codebase as small and sustainable
as possible.
Part of #577.

This is great because it allows us to remove the custom web components
mechanism. We could always add that back in the future if necessary, but
it does add a lot of complexity. So removing it makes this repo more
sustainable.

We can also remove needing to replace `furo.js` with
`qiskit-sphinx-theme.js`.
Part of #577.

We used to have a custom mobile header for the Qiskit theme to account
for the Qiskit.org top nav bar. The Ecosystem theme meanwhile reverted
to the default Furo header. We now always use the default Furo header.

This also reverts a change to the placeholder text in the search box to
mention the project name. That was to make more clear that search was
only for Qiskit docs and not all of qiskit.org. That's not relevant now.
The two themes are now equivalent and there is no longer an `/ecosystem`
folder with overrides.

A follow up PR will remove the `qiskit` theme.

## Removes blue color code

This was only used for IBM Provider and IBM Runtime, which both now live
at docs.quantum.ibm.com. We never wanted other projects to use the color
scheme.

Technically projects can still override their color by changing
`conf.py`, since Furo itself allows that. But we don't advertise it for
now.
Closes #577.

This allows us to greatly simplify the repository. Now we only have a
single theme, whereas before we had 3 themes so had to generalize a
bunch of logic like our visual regression testing.
The guides are no longer live.
We no longer use Pytorch in this project.
Closes #588 and
fixes CI breaking due to the release of Qiskit 1.0.

The major remaining reference is our guidance on how to deploy docs
projects, which is tracked by
#591.
@Eric-Arellano Eric-Arellano changed the base branch from main to 1.16 February 21, 2024 20:23
@Eric-Arellano Eric-Arellano deleted the EA/determine-branch branch August 22, 2024 14:09
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.

2 participants