Some documentation & licensing

Author: lsegal

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Loren Segal
+
+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.

README.md

@@ -61,3 +61,8 @@ Your configuration might look something like this:
 And that's it, you're all set to trigger new builds on AWS CodeBuild!
 
 [awscli]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html
+
+## License
+
+This project © 2019 by [Loren Segal](mailto:lsegal@soen.ca) and is
+licensed under the MIT license.

src/main/java/dev/lsegal/jenkins/codebuilder/CodeBuilderAgent.java

@@ -24,13 +24,20 @@ class CodeBuilderAgent extends AbstractCloudSlave {
   private static final long serialVersionUID = -6722929807051421839L;
   private final CodeBuilderCloud cloud;
 
+  /**
+   * Creates a new CodeBuilderAgent node that provisions a
+   * {@link CodeBuilderComputer}.
+   */
   public CodeBuilderAgent(@Nonnull CodeBuilderCloud cloud, @Nonnull String name, @Nonnull ComputerLauncher launcher)
       throws Descriptor.FormException, IOException {
     super(name, "AWS CodeBuild Agent", "/build", 1, Mode.NORMAL, cloud.getLabel(), launcher,
         new CloudRetentionStrategy(cloud.getAgentTimeout() / 60 + 1), Collections.emptyList());
     this.cloud = cloud;
   }
 
+  /**
+   * Get the cloud instance associated with this builder
+   */
   public CodeBuilderCloud getCloud() {
     return cloud;
   }

src/main/java/dev/lsegal/jenkins/codebuilder/CodeBuilderCloud.java

@@ -46,6 +46,11 @@
 import jenkins.model.Jenkins;
 import jenkins.model.JenkinsLocationConfiguration;
 
+/**
+ * This is the root class that contains all configuration state about the
+ * CodeBuilder cloud agents. Jenkins calls {@link CodeBuilderCloud.provision} on
+ * this class to create new nodes.
+ */
 public class CodeBuilderCloud extends Cloud {
   private static final Logger LOGGER = LoggerFactory.getLogger(CodeBuilderCloud.class);
   private static final String DEFAULT_JNLP_IMAGE = "lsegal/jnlp-docker-agent:latest";
@@ -124,7 +129,7 @@ public String getProjectName() {
   public String getRegion() {
     return region;
   }
-  
+
   @Nonnull
   public String getLabel() {
     return StringUtils.isBlank(label) ? "" : label;