Skip to content

Commit 68c8c71

Browse files
author
José Valim
committed
Update instructions with new docs setup
1 parent e2f3af9 commit 68c8c71

File tree

2 files changed

+7
-20
lines changed

2 files changed

+7
-20
lines changed

Makefile

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
REBAR ?= "$(CURDIR)/rebar"
22
PREFIX ?= /usr/local
33
SHARE_PREFIX ?= $(PREFIX)/share
4-
DOCS := master
5-
CANONICAL := master
4+
CANONICAL := master/
65
ELIXIRC := bin/elixirc --verbose --ignore-module-conflict
76
ERLC := erlc -I lib/elixir/include
87
ERL := erl -I lib/elixir/include -noshell -pa lib/elixir/ebin
@@ -17,7 +16,7 @@ INSTALL_PROGRAM = $(INSTALL) -m755
1716
GIT_REVISION = $(strip $(shell git rev-parse HEAD 2> /dev/null ))
1817
GIT_TAG = $(strip $(shell head="$(call GIT_REVISION)"; git tag --points-at $$head 2> /dev/null | tail -1) )
1918

20-
.PHONY: install compile erlang elixir build_plt clean_plt dialyze test clean install_man clean_man docs Docs.zip Precompiled.zip publish_zips publish_docs publish_mix
19+
.PHONY: install compile erlang elixir build_plt clean_plt dialyze test clean install_man clean_man docs Docs.zip Precompiled.zip zips
2120
.NOTPARALLEL: compile
2221

2322
#==> Functions
@@ -133,7 +132,7 @@ clean_exbeam:
133132
LOGO_PATH = $(shell test -f ../docs/logo.png && echo "--logo ../docs/logo.png")
134133
SOURCE_REF = $(shell tag="$(call GIT_TAG)" revision="$(call GIT_REVISION)"; echo "$${tag:-$$revision}\c")
135134
DOCS_FORMAT = html
136-
COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" -m "$(3)" -u "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) -o doc/$(2) -n http://elixir-lang.org/docs/$(CANONICAL)/$(2)/ -p http://elixir-lang.org/docs.html -f "$(DOCS_FORMAT)" $(4)
135+
COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" -m "$(3)" -u "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) -o doc/$(2) -n https://hexdocs.pm/$(2)/$(CANONICAL) -p http://elixir-lang.org/docs.html -f "$(DOCS_FORMAT)" $(4)
137136

138137
docs: compile ../ex_doc/bin/ex_doc docs_elixir docs_eex docs_mix docs_iex docs_ex_unit docs_logger
139138

@@ -183,13 +182,7 @@ Precompiled.zip: build_man compile
183182
zip -9 -r Precompiled-v$(VERSION).zip bin CHANGELOG.md lib/*/ebin LICENSE man NOTICE README.md VERSION
184183
@ echo "Precompiled file created $(CURDIR)/Precompiled-v$(VERSION).zip"
185184

186-
#==> Publish
187-
188-
publish_zips: Precompiled.zip Docs.zip
189-
190-
publish_docs: docs
191-
rm -rf ../docs/$(DOCS)/*/
192-
cp -R doc/* ../docs/$(DOCS)
185+
zips: Precompiled.zip Docs.zip
193186

194187
#==> Tests tasks
195188

RELEASE.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,13 @@ This document simply outlines the release process:
1818

1919
7. Push branch and the new tag
2020

21-
8. Publish new docs with `make publish_docs`, copy docs to `docs/stable` if appropriate, and push to GitHub Pages
21+
8. If a new `vMAJOR.MINOR`, create a new branch "vMAJOR.MINOR" and set `CANONICAL=` in Makefile before building docs
2222

23-
9. Publish new zips with `make publish_zips`, upload `Precompiled.zip` and `Docs.zip` to GitHub Releases
23+
9. Publish new zips with `make zips`, upload `Precompiled.zip` and `Docs.zip` to GitHub Releases
2424

2525
10. Add the release to `elixir.csv` file in `elixir-lang/elixir-lang.github.com`
2626

27-
## New vMAJOR.MINOR releases
28-
29-
11. Create a new branch "vMAJOR.MINOR"
30-
31-
12. Set `DOCS=vMAJOR.MINOR` and `CANONICAL=stable` in Makefile and copy them to `docs/stable` (change index.html accordingly)
32-
33-
13. In master, bump versions, start new CHANGELOG, add `-dev` back and commit "Start vVERSION+1"
27+
11. After a new `vMAJOR.MINOR`, move back to master, bump versions, start new CHANGELOG, add `-dev` back and commit "Start vMAJOR.MINOR+1"
3428

3529
## Places where version is mentioned
3630

0 commit comments

Comments
 (0)