Skip to content

Commit 75b04fa

Browse files
committed
document release process
1 parent 0c2b83d commit 75b04fa

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,52 @@ or join the [gitter chat for cwlviewer](https://gitter.im/common-workflow-langua
213213
## Changelog
214214
See [CHANGELOG](https://github.com/common-workflow-language/cwlviewer/blob/main/CHANGELOG.md)
215215

216+
## Making a development snapshot container image
217+
(and optionally publishing that image to DockerHub)
218+
219+
```shell
220+
# confirm the build arguments
221+
# if these don't look correct, troubleshoot before continuing.
222+
BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VCS_REF=$(git rev-parse HEAD) VERSION=$(git describe)
223+
echo BUILD_DATE=${BUILD_DATE} VCS_REF=${VCS_REF} VERSION=${VERSION}
224+
# build the container image
225+
docker build --build-arg BUILD_DATE=${BUILD_DATE} --build-arg VCS_REF=${VCS_REF} \
226+
--build-arg VERSION=${VERSION} \
227+
-t docker.io/commonworkflowlanguage/cwlviewer:v${VERSION} .
228+
# (optionally) push the development snapshot container image to Docker Hub
229+
docker push docker.io/commonworkflowlanguage/cwlviewer:v${new_version}
230+
```
231+
232+
## Making a release and publishing to GitHub and DockerHub
233+
234+
After CHANGELOG.md has been updated, run the following:
235+
236+
```shell
237+
new_version=1.4.1 # CHANGEME
238+
# create an annotated git tag
239+
git tag -a -m "release version ${new_version}" v${new_version}
240+
# confirm the build arguments
241+
# if these don't look correct, troubleshoot before continuing.
242+
# for example, was your tag an annotated (-a) tag?
243+
BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VCS_REF=$(git rev-parse HEAD) VERSION=$(git describe)
244+
echo BUILD_DATE=${BUILD_DATE} VCS_REF=${VCS_REF} VERSION=${VERSION}
245+
# build the container image
246+
docker build --build-arg BUILD_DATE=${BUILD_DATE} --build-arg VCS_REF=${VCS_REF} \
247+
--build-arg VERSION=${VERSION} \
248+
-t docker.io/commonworkflowlanguage/cwlviewer:v${VERSION} .
249+
# push the container image to Docker Hub
250+
docker push docker.io/commonworkflowlanguage/cwlviewer:v${VERSION}
251+
# tag this container image as :latest and push to Docker Hub
252+
docker tag docker.io/commonworkflowlanguage/cwlviewer:v{VERSION} \
253+
docker.io/commonworkflowlanguage/cwlviewer:latest
254+
docker push docker.io/commonworkflowlanguage/cwlviewer:latest
255+
# upload the annotated tag to GitHub
256+
git push --tags
257+
```
258+
259+
Then copy the changelog into https://github.com/common-workflow-language/cwlviewer/releases/new
260+
using the tag you just pushed
261+
216262
# Thanks
217263

218264
Developers and [contributors](https://github.com/common-workflow-language/cwlviewer/graphs/contributors) include:

0 commit comments

Comments
 (0)