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

upload the PDF for everybody to download #4725

Merged
merged 1 commit into from Jul 1, 2021
Merged

Conversation

yecril71pl
Copy link
Contributor

@yecril71pl yecril71pl commented Jun 29, 2021

The PDF will be available in build job results.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jun 29, 2021

Thank you, but we don't want to include PDFs in the source repository. You will notice that we attach PDFs to the labelled releases already, and PDFs appear in the public mailings as well. (We are in fact in the process of deleting the existing, historic PDFs from the repository.)

@tkoeppe tkoeppe closed this Jun 29, 2021
@yecril71pl
Copy link
Contributor Author

Thank you, but we don't want to include PDFs in the source repository. You will notice that we attach PDFs to the labelled releases already, and PDFs appear in the public mailings as well. (We are in fact in the process of deleting the existing, historic PDFs from the repository.)

I did not add any PDF to the source repository and it will not end up there once this request is accepted.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jun 29, 2021

Ah, I see. Where does the PDF go?

.github/workflows/check.yml Outdated Show resolved Hide resolved
.github/workflows/check.yml Outdated Show resolved Hide resolved
@tkoeppe tkoeppe reopened this Jun 29, 2021
@CaseyCarter
Copy link
Contributor

Ah, I see. Where does the PDF go?

It's an artifact attached to the build results, which I assume means we can easily view the result of applying a PR without needing to checkout the branch and build it locally.

@jwakely
Copy link
Member

jwakely commented Jul 1, 2021

I'm not convinced this is necessary or desirable. How long do those artefacts stay around?

Please at least squash your branch and force-push. Eight different commits for a five line change is unnecessary.

@jensmaurer
Copy link
Member

How long do those artefacts stay around?

Quote from https://github.com/actions/upload-artifact

"Artifacts are retained for 90 days by default."

We can change that per-repo; I think 14 days should be enough.
I've just changed the repo-wide maximum to 30 days.

"Billing is based on the raw uploaded size"

It seems our plan at github has 2 GB of actions space included.

@tkoeppe, I think we should squash and merge this and try it out. If it doesn't work or costs a lot, we can remove it at any time.

The uploaded PDF file will be available for download for a short time
after the action has completed.
@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 1, 2021

Hm, the artifact is currently delivered as zip file, e.g. see https://github.com/cplusplus/draft/runs/2962468115. Is that what you want? Is there a way to make the PDF available directly?

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 1, 2021

Hm,

There is currently no way to download artifacts after a workflow run finishes in a format other than a zip or to download artifact contents individually.

I suppose not. OK. Let's try this out, it seems like it could be useful. Thanks!

@tkoeppe tkoeppe merged commit 641afd1 into cplusplus:main Jul 1, 2021
@yecril71pl
Copy link
Contributor Author

Hm, the artifact is currently delivered as zip file, e.g. see https://github.com/cplusplus/draft/runs/2962468115. Is that what you want? Is there a way to make the PDF available directly?

You could add another step to upload it somewhere else, of course. I do not think it is necessary. I just wanted to prevent a situation where everybody forks and builds just to get the PDF.

@jwakely
Copy link
Member

jwakely commented Jul 1, 2021

I just wanted to prevent a situation where everybody forks and builds just to get the PDF.

I don't consider that a suitable use of this repo. "Everybody" should not need the latest working draft, and we do not need to provide them with it (they can already get a recent one from the monthly mailings at https://www.open-std.org/jtc1/sc22/wg21/ if they want a recent draft).

If somebody really needs the very latest draft then they should build it themselves.

@yecril71pl
Copy link
Contributor Author

I don't consider that a suitable use of this repo. "Everybody" should not need the latest working draft, and we do not need to provide them with it (they can already get a recent one from the monthly mailings at https://www.open-std.org/jtc1/sc22/wg21/ if they want a recent draft).

If you want that to happen, you should say so in README.

@jwakely
Copy link
Member

jwakely commented Jul 1, 2021

The project's "About" already links to it, but we could make the README more explicit.

This repo is for managing the sources, not publishing the drafts, and not for end users to easily obtain drafts.

If the purpose of this pull request is to publish the latest draft for users, then I object and want it reverted.

@JohelEGP
Copy link
Contributor

JohelEGP commented Jul 1, 2021

I've been thinking that it'd be nice to have a diffpdf output on PRs done by CI. This PR could be considered a step towards that.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 1, 2021

Hm, the artifact is currently delivered as zip file, e.g. see https://github.com/cplusplus/draft/runs/2962468115. Is that what you want? Is there a way to make the PDF available directly?

You could add another step to upload it somewhere else, of course. I do not think it is necessary. I just wanted to prevent a situation where everybody forks and builds just to get the PDF.

Hm, all it would take here is to clone this repo. If people really fork everything at the drop of a hat, there's probably not much we can do about that.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 1, 2021

I also changed the artifact name to "draft-snapshot", since the things on this repo aren't even working drafts. Working drafts are the PDFs that appear in the public mailing and are approved by the comittee.

@jensmaurer
Copy link
Member

It's good we make sure those PDFs are not marketed as "working drafts". Also, note that they are snapshots after applying pull requests, so become effectively stale after the pull request is merged.

It seems that offering the PDFs is a no-cost operation for everybody involved (including the editors), once we've overcome the discussion in the present pull request, so let's just do that.

(My opinion will change drastically if github actually starts charging for the PDFs in any way.)

@yecril71pl
Copy link
Contributor Author

yecril71pl commented Jul 1, 2021

It's good we make sure those PDFs are not marketed as "working drafts". Also, note that they are snapshots after applying pull requests, so become effectively stale after the pull request is merged.

I do not think they should be marketed at all. GitHub users will know where to find them, everybody else will have the README nicely updated by @jwakely, and that is that.

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 1, 2021

@jensmaurer: the artefacts are also available on the main branch actions, so there's a "post-commit version", too.

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.

None yet

6 participants