release 2023-03-03

BUILDING.md

@@ -0,0 +1,40 @@
+<!---
+  Licensed 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. See accompanying LICENSE file.
+-->
+
+# Building
+
+With maven, with profiles for many different hadoop versions.
+
+To build a production release
+1. Use java8
+1. And compile against a shipping hadoop version, with `-Pextra` for the extra stuff
+
+
+```bash
+mvn clean install -Phadoop-3.3.2 -Pextra
+```
+
+To publish the release use the gui or the github command line
+
+```bash
+
+set -gx date 2023-03-03
+git add .
+git commit -m "release $date"
+git push
+gh release create tag-release-$date -t release-$date -n "versioning" -d target/cloudstore-1.0.jar
+```
+
+The version `cloudstore-1.0.jar` is always used, not just from laziness but because it allows
+for bash scripts to always be able fetch the latest version through curl then execute it.

README.md

@@ -15,8 +15,9 @@ kept out right now for various reasons
 3. Ability to compile against older versions. We've currently switched to Hadoop 3.3+
    due to the need to make API calls and operations not in older versions.
 
-*Author*: Steve Loughran, Hadoop Committer, plus anyone else who has debugging needs
-
+*Author*: Steve Loughran, Hadoop Committer, plus anyone else who has debugging needs.
+
+
 ## Features
 
 ### Primarily: diagnostics
@@ -44,6 +45,13 @@ the output: we do not dare change the behaviour or output for this reason.
 when things don't work. And object stores are fairly fussy to get working, 
 primarily due to authentication, classpath and network settings
 
+## See also
+
+* [Security](./SECURITY.md)
+* [Building](./BUILDING.md)
+
+# Command Index
+
 ## Command `storediag`
 
 The `storediag` entry point is designed to pick up the FS settings, dump them

SECURITY.md

@@ -8,3 +8,7 @@ None. You are on your own. Sorry.
 
 * file an issue
 * if you have a fix, file a PR
+* if the issue is in hadoop, file an apache JIRA.
+* if the issue is in an transient dependency of hadoop, see
+  [Transitive Issues](https://steveloughran.blogspot.com/2022/08/transitive-issues.html)
+  then solve the entire software-versioning problem in java. please.