aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--Makefile14
-rw-r--r--doc/md/Release-Shaarli.md6
2 files changed, 10 insertions, 10 deletions
diff --git a/Makefile b/Makefile
index 6483fca7..40badb1d 100644
--- a/Makefile
+++ b/Makefile
@@ -159,14 +159,14 @@ composer_dependencies: clean
159 find vendor/ -name ".git" -type d -exec rm -rf {} + 159 find vendor/ -name ".git" -type d -exec rm -rf {} +
160 160
161### generate a release tarball and include 3rd-party dependencies 161### generate a release tarball and include 3rd-party dependencies
162release_tar: composer_dependencies doc_html 162release_tar: composer_dependencies htmldoc
163 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD 163 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
164 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/ 164 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
165 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/ 165 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
166 gzip $(ARCHIVE_VERSION).tar 166 gzip $(ARCHIVE_VERSION).tar
167 167
168### generate a release zip and include 3rd-party dependencies 168### generate a release zip and include 3rd-party dependencies
169release_zip: composer_dependencies doc_html 169release_zip: composer_dependencies htmldoc
170 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD 170 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
171 mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor} 171 mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
172 rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/ 172 rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
@@ -195,17 +195,11 @@ doxygen: clean
195 @rm -rf doxygen 195 @rm -rf doxygen
196 @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen - 196 @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
197 197
198### Convert local markdown documentation to HTML 198### generate HTML documentation from Markdown pages with MkDocs
199# 199htmldoc:
200# For all pages:
201# - convert GitHub-flavoured relative links to standard Markdown
202# - generate html documentation with mkdocs
203htmlpages:
204 python3 -m venv venv/ 200 python3 -m venv venv/
205 bash -c 'source venv/bin/activate; \ 201 bash -c 'source venv/bin/activate; \
206 pip install mkdocs; \ 202 pip install mkdocs; \
207 mkdocs build' 203 mkdocs build'
208 find doc/html/ -type f -exec chmod a-x '{}' \; 204 find doc/html/ -type f -exec chmod a-x '{}' \;
209 rm -r venv 205 rm -r venv
210
211doc_html: authors htmlpages
diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md
index 974a7438..e22eabc9 100644
--- a/doc/md/Release-Shaarli.md
+++ b/doc/md/Release-Shaarli.md
@@ -46,6 +46,12 @@ TBA
46 46
47 47
48## Increment the version code, update docs, create and push a signed tag 48## Increment the version code, update docs, create and push a signed tag
49### Update the list of Git contributors
50```bash
51$ make authors
52$ git commit -s -m "Update AUTHORS"
53```
54
49### Create and merge a Pull Request 55### Create and merge a Pull Request
50This one is pretty straightforward ;-) 56This one is pretty straightforward ;-)
51 57