add DEVELOPMENT.md Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/commit/bff06398 Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/tree/bff06398 Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/diff/bff06398
Branch: refs/heads/develop Commit: bff0639890744dd2a4550496ada640c88edc5f02 Parents: 2f094fa Author: Dale LaBossiere <dlab...@us.ibm.com> Authored: Tue Nov 21 16:32:24 2017 -0500 Committer: Dale LaBossiere <dlab...@us.ibm.com> Committed: Tue Nov 21 16:32:24 2017 -0500 ---------------------------------------------------------------------- DEVELOPMENT.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-edgent-samples/blob/bff06398/DEVELOPMENT.md ---------------------------------------------------------------------- diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..94675fa --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,50 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +This note is for the development and maintenance of the samples. +See [README.md](README.md) for using the samples. + +At this time an ASF release is not created for the samples - +neither a source release bundle nor binary sample artifacts are +released. The expectation is that users will get the samples +from this github repository. + +Generally, the desire is to have the samples build against the +latest released version of the runtime in Maven Central. + +Hence when a new Edgent runtime is released, the samples build tooling +should be updated to reference the new Edgent release. +E.g., when Edgent 1.3.0 is released: + +```sh + ./update-samples-version.sh --edgent-version 1.3.0 +``` + +Review the changes and stage/commit the updated files. + + +Since we're not formally releasing the samples, it's currently +unclear when we'll decide to change the sample artifact version ids. +We may try to track maintain tracking the Edgent runtime's version. +Here's the easiest way to change the sample artifact version ids +when a decision is made to change them: + +```sh + ./update-samples-version.sh --samples-version 1.3.0-SNAPSHOT +``` + +Review the changes and stage/commit the updated files.
