From e104bad5101b5628a63449f3a568250642730ffd Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 17:40:26 +0800 Subject: [PATCH 1/7] change the structure --- .env => proj/.env | 0 {.github => proj/.github}/AKNOWLEDGEMENTS.md | 0 {.github => proj/.github}/CODE_OF_CONDUCT.md | 0 {.github => proj/.github}/CONTRIBUTING.md | 0 {.github => proj/.github}/ISSUE_TEMPLATE.md | 0 .travis.yml => proj/.travis.yml | 0 LICENSE.md => proj/LICENSE.md | 0 Makefile => proj/Makefile | 0 README.md => proj/README.md | 0 build_release.sh => proj/build_release.sh | 0 {deployment => proj/deployment}/imageAPI-armv6/Makefile | 0 {deployment => proj/deployment}/imageAPI-armv6/docker-compose.yml | 0 {deployment => proj/deployment}/imageAPI-armv6/temp.env | 0 {deployment => proj/deployment}/imageAPI-x86/Makefile | 0 {deployment => proj/deployment}/imageAPI-x86/docker-compose.yml | 0 {deployment => proj/deployment}/imageAPI-x86/temp.env | 0 {gitbook => proj/gitbook}/README.md | 0 {gitbook => proj/gitbook}/SUMMARY.md | 0 {gitbook => proj/gitbook}/contribution/contribution.md | 0 {gitbook => proj/gitbook}/contribution/faq.md | 0 {gitbook => proj/gitbook}/dev/cibuild.md | 0 {gitbook => proj/gitbook}/dev/localbuild.md | 0 {gitbook => proj/gitbook}/dev/setdevenv.md | 0 {gitbook => proj/gitbook}/qs/deployment.md | 0 {gitbook => proj/gitbook}/qs/prerequisite.md | 0 {image => proj/image}/Dockerfile-armv6 | 0 {image => proj/image}/Dockerfile-x86 | 0 set_docker_account => proj/set_docker_account | 0 set_owner_repo => proj/set_owner_repo | 0 set_release_api_key => proj/set_release_api_key | 0 30 files changed, 0 insertions(+), 0 deletions(-) rename .env => proj/.env (100%) rename {.github => proj/.github}/AKNOWLEDGEMENTS.md (100%) rename {.github => proj/.github}/CODE_OF_CONDUCT.md (100%) rename {.github => proj/.github}/CONTRIBUTING.md (100%) rename {.github => proj/.github}/ISSUE_TEMPLATE.md (100%) rename .travis.yml => proj/.travis.yml (100%) rename LICENSE.md => proj/LICENSE.md (100%) rename Makefile => proj/Makefile (100%) rename README.md => proj/README.md (100%) rename build_release.sh => proj/build_release.sh (100%) rename {deployment => proj/deployment}/imageAPI-armv6/Makefile (100%) rename {deployment => proj/deployment}/imageAPI-armv6/docker-compose.yml (100%) rename {deployment => proj/deployment}/imageAPI-armv6/temp.env (100%) rename {deployment => proj/deployment}/imageAPI-x86/Makefile (100%) rename {deployment => proj/deployment}/imageAPI-x86/docker-compose.yml (100%) rename {deployment => proj/deployment}/imageAPI-x86/temp.env (100%) rename {gitbook => proj/gitbook}/README.md (100%) rename {gitbook => proj/gitbook}/SUMMARY.md (100%) rename {gitbook => proj/gitbook}/contribution/contribution.md (100%) rename {gitbook => proj/gitbook}/contribution/faq.md (100%) rename {gitbook => proj/gitbook}/dev/cibuild.md (100%) rename {gitbook => proj/gitbook}/dev/localbuild.md (100%) rename {gitbook => proj/gitbook}/dev/setdevenv.md (100%) rename {gitbook => proj/gitbook}/qs/deployment.md (100%) rename {gitbook => proj/gitbook}/qs/prerequisite.md (100%) rename {image => proj/image}/Dockerfile-armv6 (100%) rename {image => proj/image}/Dockerfile-x86 (100%) rename set_docker_account => proj/set_docker_account (100%) rename set_owner_repo => proj/set_owner_repo (100%) rename set_release_api_key => proj/set_release_api_key (100%) diff --git a/.env b/proj/.env similarity index 100% rename from .env rename to proj/.env diff --git a/.github/AKNOWLEDGEMENTS.md b/proj/.github/AKNOWLEDGEMENTS.md similarity index 100% rename from .github/AKNOWLEDGEMENTS.md rename to proj/.github/AKNOWLEDGEMENTS.md diff --git a/.github/CODE_OF_CONDUCT.md b/proj/.github/CODE_OF_CONDUCT.md similarity index 100% rename from .github/CODE_OF_CONDUCT.md rename to proj/.github/CODE_OF_CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/proj/.github/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to proj/.github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/proj/.github/ISSUE_TEMPLATE.md similarity index 100% rename from .github/ISSUE_TEMPLATE.md rename to proj/.github/ISSUE_TEMPLATE.md diff --git a/.travis.yml b/proj/.travis.yml similarity index 100% rename from .travis.yml rename to proj/.travis.yml diff --git a/LICENSE.md b/proj/LICENSE.md similarity index 100% rename from LICENSE.md rename to proj/LICENSE.md diff --git a/Makefile b/proj/Makefile similarity index 100% rename from Makefile rename to proj/Makefile diff --git a/README.md b/proj/README.md similarity index 100% rename from README.md rename to proj/README.md diff --git a/build_release.sh b/proj/build_release.sh similarity index 100% rename from build_release.sh rename to proj/build_release.sh diff --git a/deployment/imageAPI-armv6/Makefile b/proj/deployment/imageAPI-armv6/Makefile similarity index 100% rename from deployment/imageAPI-armv6/Makefile rename to proj/deployment/imageAPI-armv6/Makefile diff --git a/deployment/imageAPI-armv6/docker-compose.yml b/proj/deployment/imageAPI-armv6/docker-compose.yml similarity index 100% rename from deployment/imageAPI-armv6/docker-compose.yml rename to proj/deployment/imageAPI-armv6/docker-compose.yml diff --git a/deployment/imageAPI-armv6/temp.env b/proj/deployment/imageAPI-armv6/temp.env similarity index 100% rename from deployment/imageAPI-armv6/temp.env rename to proj/deployment/imageAPI-armv6/temp.env diff --git a/deployment/imageAPI-x86/Makefile b/proj/deployment/imageAPI-x86/Makefile similarity index 100% rename from deployment/imageAPI-x86/Makefile rename to proj/deployment/imageAPI-x86/Makefile diff --git a/deployment/imageAPI-x86/docker-compose.yml b/proj/deployment/imageAPI-x86/docker-compose.yml similarity index 100% rename from deployment/imageAPI-x86/docker-compose.yml rename to proj/deployment/imageAPI-x86/docker-compose.yml diff --git a/deployment/imageAPI-x86/temp.env b/proj/deployment/imageAPI-x86/temp.env similarity index 100% rename from deployment/imageAPI-x86/temp.env rename to proj/deployment/imageAPI-x86/temp.env diff --git a/gitbook/README.md b/proj/gitbook/README.md similarity index 100% rename from gitbook/README.md rename to proj/gitbook/README.md diff --git a/gitbook/SUMMARY.md b/proj/gitbook/SUMMARY.md similarity index 100% rename from gitbook/SUMMARY.md rename to proj/gitbook/SUMMARY.md diff --git a/gitbook/contribution/contribution.md b/proj/gitbook/contribution/contribution.md similarity index 100% rename from gitbook/contribution/contribution.md rename to proj/gitbook/contribution/contribution.md diff --git a/gitbook/contribution/faq.md b/proj/gitbook/contribution/faq.md similarity index 100% rename from gitbook/contribution/faq.md rename to proj/gitbook/contribution/faq.md diff --git a/gitbook/dev/cibuild.md b/proj/gitbook/dev/cibuild.md similarity index 100% rename from gitbook/dev/cibuild.md rename to proj/gitbook/dev/cibuild.md diff --git a/gitbook/dev/localbuild.md b/proj/gitbook/dev/localbuild.md similarity index 100% rename from gitbook/dev/localbuild.md rename to proj/gitbook/dev/localbuild.md diff --git a/gitbook/dev/setdevenv.md b/proj/gitbook/dev/setdevenv.md similarity index 100% rename from gitbook/dev/setdevenv.md rename to proj/gitbook/dev/setdevenv.md diff --git a/gitbook/qs/deployment.md b/proj/gitbook/qs/deployment.md similarity index 100% rename from gitbook/qs/deployment.md rename to proj/gitbook/qs/deployment.md diff --git a/gitbook/qs/prerequisite.md b/proj/gitbook/qs/prerequisite.md similarity index 100% rename from gitbook/qs/prerequisite.md rename to proj/gitbook/qs/prerequisite.md diff --git a/image/Dockerfile-armv6 b/proj/image/Dockerfile-armv6 similarity index 100% rename from image/Dockerfile-armv6 rename to proj/image/Dockerfile-armv6 diff --git a/image/Dockerfile-x86 b/proj/image/Dockerfile-x86 similarity index 100% rename from image/Dockerfile-x86 rename to proj/image/Dockerfile-x86 diff --git a/set_docker_account b/proj/set_docker_account similarity index 100% rename from set_docker_account rename to proj/set_docker_account diff --git a/set_owner_repo b/proj/set_owner_repo similarity index 100% rename from set_owner_repo rename to proj/set_owner_repo diff --git a/set_release_api_key b/proj/set_release_api_key similarity index 100% rename from set_release_api_key rename to proj/set_release_api_key From 515f5944fb4f2fa46e0d0c1478804c725e2872b1 Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 18:59:02 +0800 Subject: [PATCH 2/7] add travis --- .github/ACKNOWLEDGMENTS.md | 18 +++++++++++++++ .github/CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 5 +++++ .travis.yml | 21 +++++++++++++++++ LICENSE.md | 22 ++++++++++++++++++ Makefile | 10 +++++++++ README.md | 34 ++++++++++++++++++++++++++++ set_release_api_key | 2 ++ 8 files changed, 158 insertions(+) create mode 100644 .github/ACKNOWLEDGMENTS.md create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .travis.yml create mode 100644 LICENSE.md create mode 100644 Makefile create mode 100644 README.md create mode 100755 set_release_api_key diff --git a/.github/ACKNOWLEDGMENTS.md b/.github/ACKNOWLEDGMENTS.md new file mode 100644 index 0000000..cd40c6a --- /dev/null +++ b/.github/ACKNOWLEDGMENTS.md @@ -0,0 +1,18 @@ +## I would like to thank every one making this possible. + +### People making Blender better every day. + +### Special thank to + +### Donators + +### People of xxx +For kindness, support, inspiration, testing, reporting errors and general help. + + +### People of xxx +Working to provide a dedicated material library. + + +_Hope i don't forget anyone involved in the effort, if so, don't take offence and drop me a line._ + diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f273889 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at `phoenix.grey0108@gmail.com`. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..83c6ebf --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,5 @@ +## Expected behavior + +## Actual behavior + +## Step to reproduce diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7990b04 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +language: generic +sudo: required +dist: trusty +branches: + only: + - "/^\\d+\\.\\d+(\\.\\d+)?(-\\S*)?$/" + +install: true +script: +- make build VERSION=$TRAVIS_TAG +deploy: +- provider: releases + prerelease: true + skip_cleanup: true + file_glob: true + file: "./*.zip" + on: + tags: true + all_branches: true + api_key: + secure: PcDhPjWzKWd2rlatSporbaFmrrhlrV9mJswU6er99O9GtG9mo6uz2gOVy4tD1unLwonzhVQyedjZUNO+TSxhm1OzlCJByx8CGGSBsmw3bY+HFHLAAB5tDTq4vdMfufYgfT9OElLpg6bCe4YgrY8ckR4IIrcPUM+fYQSqHVLQn+LEeZRv6ekt+OgqRlfpOGeTo2dndGlqsU1nqCRODgileShHp5mTV3Zgfax8ftWwOLH29KSNjcat2R81LJONcSSEkagefFUa6j6BA1LkQm22weDctLaZY3jt+udqXY9iLD+NOTiLvkLoCbHL/29Js7B0NlnO/6Q0lik9OMDYsEsDY+uOLPKFUrnhGnd5fsIS0FaWeJeW07l7tWRVuEA5aGTHadyoFw6Mc6HhIIhB0rzlCioIUQR0odyQb9oI+0Vraa/b0oRoBrjKh2SuYgcJZ5D2o+A9u6PoCtm+SqV4hN6uficePwP2HrBIdCl4bHNQaKPiheDUZShlRS87YB/TN+R3wt7pIXaIvkh8dIlq/vd8f7UFcVe28H7I1gix4eQcyfWOmDZbZ1KpG4On3XTvZQLR4aXzzmzYKz5J7vwpzY+hv1ON8IahU8Fa5KOGadB6/u366hoIZMkSFCuVuwEnCzyEfIvhum740f4gRWFUOSLmmNoAxPGCxtlCq/2otEqRXVY= diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..fb6ad90 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2017 MatchboxLab + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..09e1b5e --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +SRC = proj +VERSION = test +ARTS = $(SRC)-$(VERSION).zip + +build: $(SRC) + zip -r $(ARTS) $(SRC) + unzip -l $(ARTS) + +clean: $(ARTS) + rm -rf $(ARTS) diff --git a/README.md b/README.md new file mode 100644 index 0000000..65c896c --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +

+ +

+ +

Project Title

+

+ One Paragraph of project description goes here +

+
+ +[![GitHub release](https://img.shields.io/github/release/hellstein/devops-docker.svg)](https://github.com/hellstein/devops-docker/releases) +![Github All Releases](https://img.shields.io/github/downloads/hellstein/devops-docker/total.svg) +![Travis (.org) branch](https://img.shields.io/travis/hellstein/devops-docker/BRANCH.svg) +![GitHub](https://img.shields.io/github/license/hellstein/devops-docker.svg) + +# How to use +Please check the [github page](https://hellstein.github.io/devops-docker) for this project. + +# How to contribute +* Please check the [github page](https://hellstein.github.io/devops-docker) for this project. +* Join the [gitter](https://gitter.im/hellstein/community) + +# Logistics +### Code of conduct +For details on our [code of conduct](https://github.com/hellstein/devops-docker/blob/master/.github/CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. +### Versioning +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository +### Authors +* **dorrywhale** - *Initial work* - [dorrywhale](https://github.com/dorrywhale) +* See also the list of [contributors](https://github.com/hellstein/devops-docker/graphs/contributors) who participated in this project. +### Acknowledgments +See [Acknowledgments](https://github.com/hellstein/devops-docker/blob/master/.github/ACKNOWLEDGMENTS.md) +### License +This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/hellstein/devops-docker/blob/master/LICENSE.md) file for details diff --git a/set_release_api_key b/set_release_api_key new file mode 100755 index 0000000..3fdee0f --- /dev/null +++ b/set_release_api_key @@ -0,0 +1,2 @@ +#! /bin/bash +travis encrypt $1 --add deploy.api_key From 7a70bf6cdf5bab58b18e5377f4657d021958c01f Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 19:15:40 +0800 Subject: [PATCH 3/7] update key --- .travis.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 7990b04..f174517 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,6 @@ dist: trusty branches: only: - "/^\\d+\\.\\d+(\\.\\d+)?(-\\S*)?$/" - install: true script: - make build VERSION=$TRAVIS_TAG @@ -18,4 +17,4 @@ deploy: tags: true all_branches: true api_key: - secure: PcDhPjWzKWd2rlatSporbaFmrrhlrV9mJswU6er99O9GtG9mo6uz2gOVy4tD1unLwonzhVQyedjZUNO+TSxhm1OzlCJByx8CGGSBsmw3bY+HFHLAAB5tDTq4vdMfufYgfT9OElLpg6bCe4YgrY8ckR4IIrcPUM+fYQSqHVLQn+LEeZRv6ekt+OgqRlfpOGeTo2dndGlqsU1nqCRODgileShHp5mTV3Zgfax8ftWwOLH29KSNjcat2R81LJONcSSEkagefFUa6j6BA1LkQm22weDctLaZY3jt+udqXY9iLD+NOTiLvkLoCbHL/29Js7B0NlnO/6Q0lik9OMDYsEsDY+uOLPKFUrnhGnd5fsIS0FaWeJeW07l7tWRVuEA5aGTHadyoFw6Mc6HhIIhB0rzlCioIUQR0odyQb9oI+0Vraa/b0oRoBrjKh2SuYgcJZ5D2o+A9u6PoCtm+SqV4hN6uficePwP2HrBIdCl4bHNQaKPiheDUZShlRS87YB/TN+R3wt7pIXaIvkh8dIlq/vd8f7UFcVe28H7I1gix4eQcyfWOmDZbZ1KpG4On3XTvZQLR4aXzzmzYKz5J7vwpzY+hv1ON8IahU8Fa5KOGadB6/u366hoIZMkSFCuVuwEnCzyEfIvhum740f4gRWFUOSLmmNoAxPGCxtlCq/2otEqRXVY= + secure: bOaoJIWQzT5Vd2WyIkSNM3oBDnZM27WRnIsLLUTp4XscQ3G4PGwZ6OfpjvIGb9zXbv3uLSQ63A1NiulVVryMZWSVDr0awzxcYjY1p8hMztuav2CPYUOgkTWtuWAsIbsNOFw+A3dsWfCHJs+jOuIiSnD21ic8ppcjyaag43cfrJYV1ERLP1PLqC2Sk1GEoJi9NpbcmE7jLr1VDec1PJ5NENt7Ot68+a218nSCMyGZFQ67lNDgcxKF+53xMEJXZ4lxmqsOklhUqmhLIn72BuzgrNcLo7Stc/sBHqKqeJSheWZ1qWEfcxcKzlTaW3uJwjtAey+01FU2QeI8dgLzXa0dKH9/a5MC5c5isqjBpKgBzlWl4hHvOxWV+ElpJg6UNwVwjzSReTNscFdOxiI5lgcZ2H43kRYjS+y+SkGPmtyt7d1NXUjPu3SNl8LNQwUtb8w6cm74B5+Rd2ME9ADNI8EyDJL27I/q7MaZ8egcaGJ2duW9zMNJ+2KMhg6M2RLsh+SAz7ya68KlsFqTHUfbIu0IszsTVfF1TJ8CXhhNCpknQ8dhS5yu9E2RermOmtwDAlbzzLzEZr7kovFasUIGzK7eBuatJ+Ph7Vo28f1birQ1mpcRqJOJwzlWG04b+5ZXc4HzcdDmCH4G+TM51S4gSw9TasuY2XuAhLeRIepoULva/sI= From f2efa35de2ea9d39542dcf9df80c5413c530ebf0 Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 19:58:04 +0800 Subject: [PATCH 4/7] update readme --- README.md | 49 +++++++++++++++++++------------------------------ 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 65c896c..efe3803 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,23 @@ -

- -

+# Usage -

Project Title

-

- One Paragraph of project description goes here -

-
+### Go to your project +``` +cd myproj +``` -[![GitHub release](https://img.shields.io/github/release/hellstein/devops-docker.svg)](https://github.com/hellstein/devops-docker/releases) -![Github All Releases](https://img.shields.io/github/downloads/hellstein/devops-docker/total.svg) -![Travis (.org) branch](https://img.shields.io/travis/hellstein/devops-docker/BRANCH.svg) -![GitHub](https://img.shields.io/github/license/hellstein/devops-docker.svg) +### Get the [release](https://github.com/hellstein/devops-gitbook/releases) +``` +wget https://github.com/hellstein/devops-docker/releases/download/0.2.1/proj-0.2.1.zip +``` -# How to use -Please check the [github page](https://hellstein.github.io/devops-docker) for this project. +### Unzip +``` +unzip proj-0.2.1.zip +``` +You will see the `proj` folder. -# How to contribute -* Please check the [github page](https://hellstein.github.io/devops-docker) for this project. -* Join the [gitter](https://gitter.im/hellstein/community) - -# Logistics -### Code of conduct -For details on our [code of conduct](https://github.com/hellstein/devops-docker/blob/master/.github/CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. -### Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository -### Authors -* **dorrywhale** - *Initial work* - [dorrywhale](https://github.com/dorrywhale) -* See also the list of [contributors](https://github.com/hellstein/devops-docker/graphs/contributors) who participated in this project. -### Acknowledgments -See [Acknowledgments](https://github.com/hellstein/devops-docker/blob/master/.github/ACKNOWLEDGMENTS.md) -### License -This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/hellstein/devops-docker/blob/master/LICENSE.md) file for details +### Replacement +``` +mv proj/* proj/.[!.]* ./ +rm -rf proj* +``` From 73d8af7f0408aaeffebcce75db7a718d92c25d22 Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 19:59:00 +0800 Subject: [PATCH 5/7] update the version --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efe3803..2d7b090 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ cd myproj ### Get the [release](https://github.com/hellstein/devops-gitbook/releases) ``` -wget https://github.com/hellstein/devops-docker/releases/download/0.2.1/proj-0.2.1.zip +wget https://github.com/hellstein/devops-docker/releases/download/0.2.2/proj-0.2.2.zip ``` ### Unzip ``` -unzip proj-0.2.1.zip +unzip proj-0.2.2.zip ``` You will see the `proj` folder. From 85229565e9bcc5db8120f8bc4699e680938bceae Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 20:19:49 +0800 Subject: [PATCH 6/7] add usage --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 90 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d7b090..16cfef6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -# Usage +# Introduction + +This is a devops for docker image and its deployment (using docker compose) for armv6 and x86. It contains: +- Dockerfile template for image. +- Docker compose file template for deployment. +- gitbook template for github page. +- travis file template for CI. + +You can use this project to quick start your docker image project with the following outcome, + +* It sets up local build process +* It sets up travis build process + + +# Usage ### Go to your project ``` @@ -16,8 +30,82 @@ unzip proj-0.2.2.zip ``` You will see the `proj` folder. -### Replacement +### Set project ``` mv proj/* proj/.[!.]* ./ rm -rf proj* ``` + +### Set the `OWNER` and `REPO` with your github user and project +```bash +./set_owner_repo [OWNER] [REPO] +``` + +### Specify develop local build usage + +Till now, you can validate by + +* Local build process + - Create docker image by `make mk-image ARCH=x86` or `make mk-image ARCH=armv6`. Test result with `docker images`. + + - Create gitbook by `make mk-book`, a docs folder will be generated + - Create deployment by `make mk-deployment VERSION=0.1.0`, 2 zip packages will be generated according to your repository name and version. + +* Local clean process + - Delete docker image by `make clean-image ARCH=x86` or `make clean-image ARCH=armv6` + - Delete gitbook result by `make clean-book` + - Delete deployment result by `make clean-deployment VERSION=0.1.0` + +### Write the image dockerfile and the image deployment +- Modify `images/Dockerfile-armv6(x86)` which defines how to build images +- Go to `deployment/imageAPI-armv6 (x86)` + * Update `docker-compose.yml` which defines how to run images + * Update `temp.env` which defines environment variable used by `docker-compose.yml` + +### Valid dockerfile and image deployment as before + +### Travis build + +- specify the docker hub account info + * `travis login` + * `travis enable` + * Change `.env` by setting `DOCKER_USER` and `DOCKER_PASS` + * `./set_docker_account` + +- Set github release api key + + Go to [github and get a token](https://github.com/settings/tokens). +```bash +./set_release_api_key [token] +``` +- Modify the indentation like below: +```yaml +deploy: +- provider: script + script: make pushtohub USER=$DOCKER_USER PASS=$DOCKER_PASS ARCH=$ARCH TAG=$TRAVIS_BRANCH + on: + all_branches: true + condition: "$TRAVIS_BRANCH =~ ^master|develop$" +- provider: script + script: make pushtohub USER=$DOCKER_USER PASS=$DOCKER_PASS ARCH=$ARCH TAG=$TRAVIS_TAG + on: + tags: true + all_branches: true +- provider: releases + prerelease: true + skip_cleanup: true + file_glob: true + file: "./*.zip" + api_key: + secure: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + on: + tags: true +``` +- Test whether .travis.yml is ok +```bash +travis lint .travis.yml +``` + +- Now you can push a branch or tag to check whether travis does its job as expected + + From 14b8426d76e18819c9faf82effcbe7a67493397b Mon Sep 17 00:00:00 2001 From: "phoenix.lv" Date: Sat, 30 Mar 2019 20:27:51 +0800 Subject: [PATCH 7/7] update version --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16cfef6..44eaabe 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,12 @@ cd myproj ### Get the [release](https://github.com/hellstein/devops-gitbook/releases) ``` -wget https://github.com/hellstein/devops-docker/releases/download/0.2.2/proj-0.2.2.zip +wget https://github.com/hellstein/devops-docker/releases/download/0.2.3/proj-0.2.3.zip ``` ### Unzip ``` -unzip proj-0.2.2.zip +unzip proj-0.2.3.zip ``` You will see the `proj` folder.