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

Fix PDF generation (or delete this sentence?) #588

Open
smoyer64 opened this issue Jun 12, 2020 · 3 comments
Open

Fix PDF generation (or delete this sentence?) #588

smoyer64 opened this issue Jun 12, 2020 · 3 comments

Comments

@smoyer64
Copy link

The README.md file at the root of this repository states:

For the specification at a given release or milestone, download the PDF from the GitHub releases page.

But it appears that PDF files haven't been generated for quite a while and/or they're only generated for major/minor revisions? What would be really nice is to have a link to the latest PDF spec.

@jmartisk
Copy link
Contributor

That's right, we only do this for major and minor releases. Micro updates are most often just bugfixes and usually don't change the specification text, because that could potentially lead to backward compatibility problems. We don't even maintain the changelog for micro releases, so it would be hard to spot what changed if you just read the PDF. If you really need to know what's changed in a micro release, you can look at the commit history in the respective branch.
If we invented an automated way to attach the PDFs, it would be possible, but right now it's manual, so I guess no one is willing to do it for micro releases :)

I'd be for changing the sentence so that it says we do this for major and minor releases. @donbourne

@donbourne
Copy link
Member

+1 for changing the sentence to reflect that we do it for major and minor releases. I don't think it would add value to have new PDFs for every micro release since those would be the same as the minor release PDFs.

@smoyer64
Copy link
Author

Okay ... that sounds like a good solution. I found what I was looking for eventually but perhaps that change would save people a bit of time.

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

No branches or pull requests

3 participants