generated from caltechlibrary/template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
132 lines (102 loc) · 5.98 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# =============================================================================
# @file Makefile
# @brief Makefile for some steps in creating new releases on GitHub
# @author Michael Hucka
# @date 2020-08-11
# @license Please see the file named LICENSE in the project directory
# @website https://github.com/caltechlibrary/coif
# =============================================================================
# Before we go any further, test if certain programs are available.
# The following is based on the approach posted by Jonathan Ben-Avraham to
# Stack Overflow in 2014 at https://stackoverflow.com/a/25668869
PROGRAMS_NEEDED = curl gh git jq sed
TEST := $(foreach p,$(PROGRAMS_NEEDED),\
$(if $(shell which $(p)),_,$(error Cannot find program "$(p)")))
# Gather values that we need ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
$(info Gathering data -- this takes a few moments ...)
name := $(strip $(shell grep -m 1 'name\s*=' setup.cfg | cut -f2 -d'='))
version := $(strip $(shell grep -m 1 'version\s*=' setup.cfg | cut -f2 -d'='))
url := $(strip $(shell grep -m 1 'url\s*=' setup.cfg | cut -f2 -d'='))
desc := $(strip $(shell grep -m 1 'description\s*=' setup.cfg | cut -f2 -d'='))
author := $(strip $(shell grep -m 1 'author\s*=' setup.cfg | cut -f2 -d'='))
email := $(strip $(shell grep -m 1 'author_email\s*=' setup.cfg | cut -f2 -d'='))
license := $(strip $(shell grep -m 1 'license\s*=' setup.cfg | cut -f2 -d'='))
branch := $(shell git rev-parse --abbrev-ref HEAD)
repo := $(strip $(shell gh repo view | head -1 | cut -f2 -d':'))
id := $(shell curl -s https://api.github.com/repos/$(repo) | jq '.id')
id_url := https://data.caltech.edu/badge/latestdoi/$(id)
doi_url := $(shell curl -sILk $(id_url) | grep Locat | cut -f2 -d' ')
doi := $(subst https://doi.org/,,$(doi_url))
doi_tail := $(lastword $(subst ., ,$(doi)))
init_file := $(name)/__init__.py
tmp_file := $(shell mktemp /tmp/release-notes-$(name).XXXXXX)
$(info Gathering data ... Done.)
# make release ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
release: | test-branch release-on-github print-instructions
test-branch:
ifneq ($(branch),main)
$(error Current git branch != main. Merge changes into main first)
endif
update-init-file:;
@sed -i .bak -e "s|^\(__version__ *=\).*|\1 '$(version)'|" $(init_file)
@sed -i .bak -e "s|^\(__description__ *=\).*|\1 '$(desc)'|" $(init_file)
@sed -i .bak -e "s|^\(__url__ *=\).*|\1 '$(url)'|" $(init_file)
@sed -i .bak -e "s|^\(__author__ *=\).*|\1 '$(author)'|" $(init_file)
@sed -i .bak -e "s|^\(__email__ *=\).*|\1 '$(email)'|" $(init_file)
@sed -i .bak -e "s|^\(__license__ *=\).*|\1 '$(license)'|" $(init_file)
update-codemeta-file:;
@sed -i .bak -e "/version/ s/[0-9].[0-9][0-9]*.[0-9][0-9]*/$(version)/" codemeta.json
edited := codemeta.json $(init_file)
check-in-updated-files:;
git add $(edited)
git diff-index --quiet HEAD $(edited) || \
git commit -m"Update stored version number" $(edited)
release-on-github: | update-init-file update-codemeta-file check-in-updated-files
git push -v --all
git push -v --tags
$(info ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓)
$(info ┃ Write release notes in the file that will be opened in your editor ┃)
$(info ┃ then save and close the file to complete this release process. ┃)
$(info ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛)
sleep 2
$(EDITOR) $(tmp_file)
gh release create v$(version) -t "Release $(version)" -F $(tmp_file)
print-instructions:;
$(info ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓)
$(info ┃ Next steps: ┃)
$(info ┃ 1. Visit https://github.com/$(repo)/releases )
$(info ┃ 2. Double-check the release ┃)
$(info ┃ 3. Wait a few seconds to let web services do their work ┃)
$(info ┃ 4. Run "make update-doi" to update the DOI in README.md ┃)
$(info ┃ 5. Run "make create-dist" and check the distribution for problems ┃)
$(info ┃ 6. Run "make test-pypi" to push to test.pypi.org ┃)
$(info ┃ 7. Double-check https://test.pypi.org/$(repo) )
$(info ┃ 8. Run "make pypi" to push to pypi for real ┃)
$(info ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛)
@echo ""
update-doi:
sed -i .bak -e 's|/api/record/[0-9]\{1,\}|/api/record/$(doi_tail)|' README.md
sed -i .bak -e 's|edu/records/[0-9]\{1,\}|edu/records/$(doi_tail)|' README.md
git add README.md
git diff-index --quiet HEAD README.md || \
(git commit -m"Update DOI" README.md && git push -v --all)
create-dist: clean
python3 setup.py sdist bdist_wheel
python3 -m twine check dist/*
test-pypi: create-dist
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
pypi: create-dist
python3 -m twine upload dist/*
# Cleanup and miscellaneous directives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
clean: clean-dist clean-build clean-release clean-other
clean-dist:;
-rm -fr dist/$(name) dist/$(name)-$(version).tar.gz \
dist/$(name)-$(version)-py3-none-any.whl
clean-build:;
-rm -rf build
clean-release:;
-rm -rf $(name).egg-info codemeta.json.bak $(init_file).bak README.md.bak
clean-other:;
-rm -fr $(name)/__pycache__
.PHONY: release release-on-github update-init-file update-codemeta-file \
print-instructions create-dist clean test-pypi pypi