Skip to content
This repository
Browse code

releasing Rails no longer needs triggering docs generation by hand [c…

…i skip]

GitHub is now able to notify tag creation, I have configured the webhook
for the docs server to receive that event. Therefore, we no longer need
to trigger docs generation manually when releasing.
  • Loading branch information...
commit 5b8f95f402a6dea80fb11df2b6c5ff384419fe0a 1 parent 95bacbe
Xavier Noria fxn authored

Showing 2 changed files with 0 additions and 37 deletions. Show diff stats Hide diff stats

  1. +0 31 RELEASING_RAILS.rdoc
  2. +0 6 Rakefile
31 RELEASING_RAILS.rdoc
Source Rendered
@@ -203,34 +203,3 @@ There are two simple steps for fixing the CI:
203 203 2. Fix it
204 204
205 205 Repeat these steps until the CI is green.
206   -
207   -=== Manually trigger docs generation
208   -
209   -We have a post-receive hook in GitHub that calls the docs server on pushes.
210   -It triggers generation and publication of edge docs, updates the contrib app,
211   -and generates and publishes stable docs if a new stable tag is detected.
212   -
213   -The hook unfortunately is not invoked by tag pushing, so once the new stable
214   -tag has been pushed to origin, please run
215   -
216   - rake publish_docs
217   -
218   -You should see something like this:
219   -
220   - Rails master hook tasks scheduled:
221   -
222   - * updates the local checkout
223   - * updates Rails Contributors
224   - * generates and publishes edge docs
225   -
226   - If a new stable tag is detected it also
227   -
228   - * generates and publishes stable docs
229   -
230   - This needs typically a few minutes.
231   -
232   -Note you do not need to specify the tag, the docs server figures it out.
233   -
234   -Also, don't worry if you call that multiple times or the hook is triggered
235   -again by some immediate regular push, if the scripts are running new calls
236   -are just queued (in a queue of size 1).
6 Rakefile
@@ -74,7 +74,6 @@ task :update_versions do
74 74 end
75 75 end
76 76
77   -#
78 77 # We have a webhook configured in GitHub that gets invoked after pushes.
79 78 # This hook triggers the following tasks:
80 79 #
@@ -84,11 +83,6 @@ end
84 83 # * if there's a new stable tag, generates and publishes stable docs
85 84 #
86 85 # Everything is automated and you do NOT need to run this task normally.
87   -#
88   -# We publish a new version by tagging, and pushing a tag does not trigger
89   -# that webhook. Stable docs would be updated by any subsequent regular
90   -# push, but if you want that to happen right away just run this.
91   -#
92 86 desc 'Publishes docs, run this AFTER a new stable tag has been pushed'
93 87 task :publish_docs do
94 88 Net::HTTP.new('api.rubyonrails.org', 8080).start do |http|

0 comments on commit 5b8f95f

Please sign in to comment.
Something went wrong with that request. Please try again.