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

Do not commit the index.html file. #936

Closed
5 tasks
niccokunzmann opened this issue Apr 7, 2017 · 3 comments
Closed
5 tasks

Do not commit the index.html file. #936

niccokunzmann opened this issue Apr 7, 2017 · 3 comments
Labels
developer-experience Dev tooling, test framework, and CI

Comments

@niccokunzmann
Copy link
Contributor

niccokunzmann commented Apr 7, 2017

Context: The index.html file is generated from the try.html file with the command make website.
Problem: This cases merge conflicts for generated code, makes commits bigger, duplicates code to maintain.

Solution:

  • Clarify if index.html should be tracked by git at all
  • remove the description in the tutorial that it should be committed
  • Add the building of the index.html page to the deploy script source
  • Document:
    • maybe: make travis fail if the last commit changes the index.html file as a warning to contributors
    • Change the README and other documentation files to document that this file does not need to be touched
@paulmelnikow
Copy link
Member

We could run make website at deploy time, and push the updated index.html to master.

It's a good question you raise. Should it be tracked at all? We could consider removing it from tracking in master. It would have to be committed to the gh-pages branch, though that could be done on a detached head as part of the deploy scripts, which would mean most contributors would never see it.

There's a real advantage to that: removing it from tracking in master would take the chance of confusion to zero.

I don't know whether the index.html is needed anywhere else. Should find that out.

@paulmelnikow paulmelnikow added the developer-experience Dev tooling, test framework, and CI label Apr 7, 2017
@paulmelnikow
Copy link
Member

This happened again in #949.

index.html does not seem to be needed for development. I'd suggest we modify the deploy-gh-pages target to build index.html and commit it, before the force-push to gh-pages.

@paulmelnikow
Copy link
Member

Opened a PR: #954.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Dev tooling, test framework, and CI
Projects
None yet
Development

No branches or pull requests

2 participants