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

use a git post-commit hook to build and commit changes in the doc #35

Open
stepheneb opened this issue Mar 20, 2011 · 0 comments
Open

Comments

@stepheneb
Copy link
Contributor

If you want the doc checked into the repo It would be great to have a git post-commit hook check to see if the doc needs to be re-built and if so build and commit the changes.

I'm suggesting a post-commit hook because then whatever commit you make stays whole and the commit narrative for the changes you just made aren't muddied-up by the commit changes in the doc files.

I'm looking at the glge code and considering working on i it and after cloning, changing the first line of build.js to look for node in all standard locations (my node is in /usr/local/bin);

#!/usr/bin/env node

and then after building successfully -- when I run git status it shows a long list of changes to doc files that are checked in and also a bunch that are not checked in. Unless I commit these into a branch they will show up whenever I am checking what need's to be committed.

But if I have a change and I develop it into a branch and push it to github for you to consider I don't want to include the doc changes (unless they're changes that occur because of my changes) those are your responsibility to decide when to include.

Here's what git status shows after a successful clone and build:

[glge-git (master)]$ git status
# On branch master
# Changed but not updated:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#   modified:   build.js
#   modified:   docs/files.html
#   modified:   docs/index.html
#   modified:   docs/symbols/GLGE.Action.html
#   modified:   docs/symbols/GLGE.ActionChannel.html
#   modified:   docs/symbols/GLGE.Animatable.html
#   modified:   docs/symbols/GLGE.AnimationCurve.html
#   modified:   docs/symbols/GLGE.AnimationVector.html
#   modified:   docs/symbols/GLGE.Assets.html
#   modified:   docs/symbols/GLGE.BezTriple.html
#   modified:   docs/symbols/GLGE.Camera.html
#   modified:   docs/symbols/GLGE.Collada.html
#   modified:   docs/symbols/GLGE.Document.html
#   modified:   docs/symbols/GLGE.Events.html
#   modified:   docs/symbols/GLGE.Group.html
#   modified:   docs/symbols/GLGE.HeightMap.html
#   modified:   docs/symbols/GLGE.JSONLoader.html
#   modified:   docs/symbols/GLGE.KeyInput.html
#   modified:   docs/symbols/GLGE.Light.html
#   modified:   docs/symbols/GLGE.LinearPoint.html
#   modified:   docs/symbols/GLGE.Material.html
#   modified:   docs/symbols/GLGE.MaterialLayer.html
#   modified:   docs/symbols/GLGE.Mesh.html
#   modified:   docs/symbols/GLGE.Message.html
#   modified:   docs/symbols/GLGE.MouseInput.html
#   modified:   docs/symbols/GLGE.MultiMaterial.html
#   modified:   docs/symbols/GLGE.Object.html
#   modified:   docs/symbols/GLGE.ObjectLod.html
#   modified:   docs/symbols/GLGE.ParticleSystem.html
#   modified:   docs/symbols/GLGE.Placeable.html
#   modified:   docs/symbols/GLGE.QuickNotation.html
#   modified:   docs/symbols/GLGE.Renderer.html
#   modified:   docs/symbols/GLGE.Scene.html
#   modified:   docs/symbols/GLGE.StepPoint.html
#   modified:   docs/symbols/GLGE.Text.html
#   modified:   docs/symbols/GLGE.Texture.html
#   modified:   docs/symbols/GLGE.TextureCamera.html
#   modified:   docs/symbols/GLGE.TextureCanvas.html
#   modified:   docs/symbols/GLGE.TextureCube.html
#   modified:   docs/symbols/GLGE.TextureVideo.html
#   modified:   docs/symbols/GLGE.Wavefront.html
#   modified:   docs/symbols/GLGE.html
#   modified:   docs/symbols/_global_.html
#   modified:   docs/symbols/src/src_core_glge.js.html
#   modified:   docs/symbols/src/src_core_glge_math.js.html
#   modified:   docs/symbols/src/src_extra_glge_collada.js.html
#   modified:   docs/symbols/src/src_extra_glge_filter2d.js.html
#   modified:   docs/symbols/src/src_extra_glge_wavefront.js.html
#
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#   devtemplate.html
#   docs/symbols/GLGE.FilterGlow.html
#   docs/symbols/src/src_animation_glge_action.js.html
#   docs/symbols/src/src_animation_glge_actionchannel.js.html
#   docs/symbols/src/src_animation_glge_animationcurve.js.html
#   docs/symbols/src/src_animation_glge_animationpoints.js.html
#   docs/symbols/src/src_animation_glge_animationvector.js.html
#   docs/symbols/src/src_core_glge_animatable.js.html
#   docs/symbols/src/src_core_glge_document.js.html
#   docs/symbols/src/src_core_glge_event.js.html
#   docs/symbols/src/src_core_glge_group.js.html
#   docs/symbols/src/src_core_glge_jsonloader.js.html
#   docs/symbols/src/src_core_glge_messages.js.html
#   docs/symbols/src/src_core_glge_placeable.js.html
#   docs/symbols/src/src_core_glge_quicknote.js.html
#   docs/symbols/src/src_extra_filters_glge_filter_glow.js.html
#   docs/symbols/src/src_geometry_glge_mesh.js.html
#   docs/symbols/src/src_material_glge_material.js.html
#   docs/symbols/src/src_material_glge_materiallayer.js.html
#   docs/symbols/src/src_material_glge_multimaterial.js.html
#   docs/symbols/src/src_material_glge_texture.js.html
#   docs/symbols/src/src_material_glge_texturecamera.js.html
#   docs/symbols/src/src_material_glge_texturecanvas.js.html
#   docs/symbols/src/src_material_glge_texturecube.js.html
#   docs/symbols/src/src_material_glge_texturevideo.js.html
#   docs/symbols/src/src_renderable_glge_lod.js.html
#   docs/symbols/src/src_renderable_glge_object.js.html
#   docs/symbols/src/src_renderable_glge_text.js.html
#   docs/symbols/src/src_renders_glge_renderer.js.html
#   docs/symbols/src/src_scene_glge_camera.js.html
#   docs/symbols/src/src_scene_glge_light.js.html
#   docs/symbols/src/src_scene_glge_scene.js.html
no changes added to commit (use "git add" and/or "git commit -a")
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

1 participant