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

Prepare second docs artifact, for human consumption #12

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

garrison
Copy link
Member

@garrison garrison commented Sep 6, 2024

This is what it would look like if we were to generate a second docs artifact, meant for human consumption. The reason we might want to do this because some of us (me) will be more likely to download and look at a docs preview if the artifact is nicer to work with. The reason we might not want to do this is because it adds lines to our CI configuration.

Follow-up to #5 (comment) and #8.


UPDATE: actually, after trying to work with the github-pages artifact, I am much in favor of this. Working with that one basically involves

mkdir /tmp/newdir
cd /tmp/newdir
unzip '~/Downloads/github-pages (39).zip'
tar xf artifact.tar

while this artifact for humans can be extracted easily anywhere using unzip without causing much harm (everything in a single subdirectory with the same name).

@coveralls
Copy link

coveralls commented Sep 6, 2024

Pull Request Test Coverage Report for Build 10777419036

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 10770310602: 0.0%
Covered Lines: 297
Relevant Lines: 297

💛 - Coveralls

@mrossinek
Copy link
Member

Is this really needed? You can just as easily get the github-pages artifact from the actions tab, for example: https://github.com/Qiskit/qiskit-addon-utils/actions/runs/10770310597

@garrison
Copy link
Member Author

garrison commented Sep 9, 2024

Is this really needed? You can just as easily get the github-pages artifact from the actions tab, for example.

I mentioned this in the update, above. You might not have seen that if you read only the email notification.

That artifact has a generic name and extracts into a tar file which then can be extracted into the current directory. The artifact for humans has an intentional name and extracts into a subdirectory. It's meant to be more convenient to work with.

Copy link
Member

@mrossinek mrossinek left a comment

Choose a reason for hiding this comment

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

I indeed overlooked your updated description.

I still do not see a pressing need for this, but it does not harm 👍

@garrison garrison marked this pull request as ready for review September 9, 2024 16:36
@garrison garrison enabled auto-merge (squash) September 9, 2024 16:37
@garrison garrison merged commit d9e0926 into main Sep 9, 2024
15 checks passed
@mrossinek mrossinek deleted the artifact-for-humans branch September 9, 2024 18:32
@mrossinek mrossinek added the stable backport potential Label for mergify to open a backport PR label Sep 10, 2024
mergify bot pushed a commit that referenced this pull request Sep 10, 2024
mrossinek pushed a commit that referenced this pull request Sep 10, 2024
(cherry picked from commit d9e0926)

Co-authored-by: Jim Garrison <[email protected]>
@garrison garrison added the ci-cd Related to CI/CD pipeline label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci-cd Related to CI/CD pipeline stable backport potential Label for mergify to open a backport PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants