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

Stop checking in PDFs #1632

Closed
jericson-edb opened this issue Jul 30, 2021 · 6 comments
Closed

Stop checking in PDFs #1632

jericson-edb opened this issue Jul 30, 2021 · 6 comments
Assignees

Comments

@jericson-edb
Copy link
Contributor

We are committing PDFs to Git, which is not recommended. Worse, it's making everything slower than it should be as we ship patches for binary files back and forth. The goal is to remove PDFs from Git history and move other binary files (screenshots, etc.) to LFS. Before we do that, however, we need to stop checking in PDFs and manually move them to Netlify/Heroku.

Here's the plan for that step. I'm going to:

  1. create a new branch off of develop,
  2. copy the .github/workflows/deploy-develop.yml action and edit it to only trigger when my new branch is pushed,
  3. pull in the PDF generation step from .github/workflows/update-pdfs-on-develop.yml and
  4. make sure this all works the way I think it does.

If that test works, we can retire the update-pdfs-on-develop workflow and fix the other workflows to do what we need. If it doesn't work, I can test on my branch without (I think) disrupting anyone else. (Also, it's close enough to the weekend that I don't think there are people around to be disrupted.)

@jericson-edb jericson-edb self-assigned this Jul 30, 2021
@gsong
Copy link
Contributor

gsong commented Jul 30, 2021

@jericson-edb Sounds like a solid plan. Good luck.

@jericson-edb
Copy link
Contributor Author

Ok, this test seems to have worked. But it occurs to me that the PDFs are still in the repo so I can't be sure it's picking up the generated PDFs. So I'm going to remove the PDFs from my branch (not history, just a git rm) and see what happens. Also, I'm not sure we need to install Python since the VM image includes it. Maybe we need a specific Python? Anyway, it doesn't hurt to test it.

@gsong
Copy link
Contributor

gsong commented Jul 30, 2021

Check out https://github.com/EnterpriseDB/docs/blob/develop/docker/images/Dockerfile.pdf-builder for specific Pandoc version. Ubuntu installs Python 3.8.10.

@jericson-edb
Copy link
Contributor Author

Left the Python install alone. :-)

Removing the PDFs does seem to have worked out. Noticed there is a build timestamp to prove the right version was deliveredhttps://610469e3ed4e0b30106f1e45--edb-docs-staging.netlify.app/docs/static/3fc1582e1974e33ecdfc652f40fa0fac/epas_v13_documentation.pdf):

Built at 2021-07-30T20:59:3

It looks like this is working! Gonna clean up my branch and do a PR next. (Not sure if it'll be today or Monday.)

@gsong
Copy link
Contributor

gsong commented Jul 30, 2021

👏 Good work!

@jericson-edb
Copy link
Contributor Author

Fixed by: #1640

Onward!

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

2 participants