Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #956 from virtualtam/fix/make-authors

Browse source 
Documentation+Makefile: update AUTHORS generation
This commit is contained in:
VirtualTam 2017-09-02 13:00:45 +02:00 committed by GitHub
commit ea71536ed7
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Makefile
View file

@ -159,14 +159,14 @@ composer_dependencies: clean
find vendor/ -name ".git" -type d -exec rm -rf {} + find vendor/ -name ".git" -type d -exec rm -rf {} +
### generate a release tarball and include 3rd-party dependencies ### generate a release tarball and include 3rd-party dependencies
release_tar: composer_dependencies doc_html release_tar: composer_dependencies htmldoc
git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/ tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/ tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
gzip $(ARCHIVE_VERSION).tar gzip $(ARCHIVE_VERSION).tar
### generate a release zip and include 3rd-party dependencies ### generate a release zip and include 3rd-party dependencies
release_zip: composer_dependencies doc_html release_zip: composer_dependencies htmldoc
git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor} mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/ rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
@ -195,17 +195,11 @@ doxygen: clean
@rm -rf doxygen @rm -rf doxygen
@( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen - @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
### Convert local markdown documentation to HTML ### generate HTML documentation from Markdown pages with MkDocs
# htmldoc:
# For all pages:
# - convert GitHub-flavoured relative links to standard Markdown
# - generate html documentation with mkdocs
htmlpages:
python3 -m venv venv/ python3 -m venv venv/
bash -c 'source venv/bin/activate; \ bash -c 'source venv/bin/activate; \
pip install mkdocs; \ pip install mkdocs; \
mkdocs build' mkdocs build'
find doc/html/ -type f -exec chmod a-x '{}' \; find doc/html/ -type f -exec chmod a-x '{}' \;
rm -r venv rm -r venv
doc_html: authors htmlpages

6
doc/md/Release-Shaarli.md
View file

@ -46,6 +46,12 @@ TBA
## Increment the version code, update docs, create and push a signed tag ## Increment the version code, update docs, create and push a signed tag
### Update the list of Git contributors
```bash
$ make authors
$ git commit -s -m "Update AUTHORS"
```
### Create and merge a Pull Request ### Create and merge a Pull Request
This one is pretty straightforward ;-) This one is pretty straightforward ;-)