From 3be072541eca67c562b4ac3ce18db8dc35b7e043 Mon Sep 17 00:00:00 2001
From: s1n7ax <srineshnisala@gmail.com>
Date: Tue, 22 Oct 2024 10:22:03 +0530
Subject: [PATCH] feat: add nvim-java template

---
 .github/workflows/test-pr.yaml                |   2 +-
 README.md                                     | 123 +-----------------
 src/hello/.devcontainer/devcontainer.json     |  21 ---
 src/hello/devcontainer-template.json          |  34 -----
 .../.devcontainer/Dockerfile                  |   0
 src/nvim-java/.devcontainer/devcontainer.json |  24 ++++
 src/nvim-java/devcontainer-template.json      |  34 +++++
 test/{hello => nvim-java}/test.sh             |   0
 8 files changed, 60 insertions(+), 178 deletions(-)
 delete mode 100644 src/hello/.devcontainer/devcontainer.json
 delete mode 100644 src/hello/devcontainer-template.json
 rename src/{hello => nvim-java}/.devcontainer/Dockerfile (100%)
 create mode 100644 src/nvim-java/.devcontainer/devcontainer.json
 create mode 100644 src/nvim-java/devcontainer-template.json
 rename test/{hello => nvim-java}/test.sh (100%)

diff --git a/.github/workflows/test-pr.yaml b/.github/workflows/test-pr.yaml
index 778bed4..0c0091a 100644
--- a/.github/workflows/test-pr.yaml
+++ b/.github/workflows/test-pr.yaml
@@ -13,7 +13,7 @@ jobs:
         with:
           filters: |
             color: ./**/color/**
-            hello: ./**/hello/**
+            nvim-java: ./**/nvim-java/**
 
   test:
     needs: [detect-changes]
diff --git a/README.md b/README.md
index 974ac6d..23c40c0 100644
--- a/README.md
+++ b/README.md
@@ -1,122 +1 @@
-# Dev Container Templates: Self Authoring Guide
-
-> This repo provides a starting point and example for creating your own custom [Dev Container Templates](https://containers.dev/implementors/templates), hosted for free on GitHub Container Registry.  The example in this repository follows the [Dev Container Template distribution specification](https://containers.dev/implementors/templates-distribution/).  
->
-> To provide feedback on the distribution spec, please leave a comment [on spec issue #71](https://github.com/devcontainers/spec/issues/71).
-
-## Repo and Template Structure
-
-This repository contains a _collection_ of two Templates - `hello` and `color`. These Templates serve as simple template implementations which helps containerize the project. Similar to the [`devcontainers/templates`](https://github.com/devcontainers/templates) repo, this repository has a `src` folder.  Each Template has its own sub-folder, containing at least a `devcontainer-template.json` and `.devcontainer/devcontainer.json`. 
-
-```
-├── src
-│   ├── color
-│   │   ├── devcontainer-template.json
-│   │   └──| .devcontainer
-│   │      └── devcontainer.json
-│   ├── hello
-│   │   ├── devcontainer-template.json
-│   │   └──| .devcontainer
-│   │      ├── devcontainer.json
-│   │      └── Dockerfile
-|   ├── ...
-│   │   ├── devcontainer-template.json
-│   │   └──| .devcontainer
-│   │      └── devcontainer.json
-├── test
-│   ├── color
-│   │   └── test.sh
-│   ├── hello
-│   │   └── test.sh
-│   └──test-utils
-│      └── test-utils.sh
-...
-```
-
-### Options
-
-All available options for a Template should be declared in the `devcontainer-template.json`. The syntax for the `options` property can be found in the [devcontainer Template json properties reference](https://containers.dev/implementors/templates#devcontainer-templatejson-properties).
-
-For example, the `color` Template provides three possible options (`red`, `gold`, `green`), where the default value is set to "red".
-
-```jsonc
-{
-    // ...
-    "options": {
-        "favorite": {
-            "type": "string",
-            "description": "Choose your favorite color."
-            "proposals": [
-                "red",
-                "gold",
-                "green"
-            ],
-            "default": "red"
-        }
-    }
-}
-```
-
-An [implementing tool](https://containers.dev/supporting#tools) will use the `options` property from [the documented Dev Container Template properties](https://containers.dev/implementors/templates#devcontainer-templatejson-properties) for customizing the Template. See [option resolution example](https://containers.dev/implementors/templates#option-resolution-example) for details.
-
-## Distributing Templates
-
-**Note**: *Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src/<template>/README.md` per Template (which merges any existing `src/<template>/NOTES.md`).
-
-### Versioning
-
-Templates are individually versioned by the `version` attribute in a Template's `devcontainer-template.json`. Templates are versioned according to the semver specification. More details can be found in [the Dev Container Template specification](https://containers.dev/implementors/templates-distribution/#versioning).
-
-### Publishing
-
-> NOTE: The Distribution spec can be [found here](https://containers.dev/implementors/templates-distribution/).  
->
-> While any registry [implementing the OCI Distribution spec](https://github.com/opencontainers/distribution-spec) can be used, this template will leverage GHCR (GitHub Container Registry) as the backing registry.
-
-Templates are source files packaged together that encode configuration for a complete development environment.
-
-This repo contains a GitHub Action [workflow](.github/workflows/release.yaml) that will publish each template to GHCR.  By default, each Template will be prefixed with the `<owner/<repo>` namespace.  For example, the two Templates in this repository can be referenced by an [implementing tool](https://containers.dev/supporting#tools) with:
-
-```
-ghcr.io/devcontainers/template-starter/color:latest
-ghcr.io/devcontainers/template-starter/hello:latest
-```
-
-The provided GitHub Action will also publish a third "metadata" package with just the namespace, eg: `ghcr.io/devcontainers/template-starter`. This contains information useful for tools aiding in Template discovery.
-
-'`devcontainers/template-starter`' is known as the template collection namespace.
-
-### Marking Template Public
-
-For your Template to be used, it currently needs to be available publicly. By default, OCI Artifacts in GHCR are marked as `private`. 
-
-To make them public, navigate to the Template's "package settings" page in GHCR, and set the visibility to 'public`. 
-
-```
-https://github.com/users/<owner>/packages/container/<repo>%2F<templateName>/settings
-```
-
-### Adding Templates to the Index
-
-Next you will need to add your Templates collection to our [public index](https://containers.dev/templates) so that other community members can find them. Just follow these steps once per collection you create:
-
-* Go to [github.com/devcontainers/devcontainers.github.io](https://github.com/devcontainers/devcontainers.github.io)
-     * This is the GitHub repo backing the [containers.dev](https://containers.dev/) spec site
-* Open a PR to modify the [collection-index.yml](https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml) file
-
-This index is from where [supporting tools](https://containers.dev/supporting) like [VS Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/templates/codespaces) surface Templates for their Dev Container Creation Configuration UI.
-
-### Testing Templates
-
-This repo contains a GitHub Action [workflow](.github/workflows/test-pr.yaml) for testing the Templates. Similar to the [`devcontainers/templates`](https://github.com/devcontainers/templates) repo, this repository has a `test` folder.  Each Template has its own sub-folder, containing at least a `test.sh`.
-
-For running the tests locally, you would need to execute the following commands -
-
-```
-    ./.github/actions/smoke-test/build.sh ${TEMPLATE-ID} 
-    ./.github/actions/smoke-test/test.sh ${TEMPLATE-ID} 
-```
-
-### Updating Documentation
-
-This repo contains a GitHub Action [workflow](.github/workflows/release.yaml) that will automatically generate documentation (ie. `README.md`) for each Template. This file will be auto-generated from the `devcontainer-template.json` and `NOTES.md`.
+# starter-devcontainer
diff --git a/src/hello/.devcontainer/devcontainer.json b/src/hello/.devcontainer/devcontainer.json
deleted file mode 100644
index fc33f83..0000000
--- a/src/hello/.devcontainer/devcontainer.json
+++ /dev/null
@@ -1,21 +0,0 @@
-{
-	"name": "Hello, World",
-	"build": {
-		"dockerfile": "Dockerfile"
-	},
-
-	// 👇 Features to add to the Dev Container. More info: https://containers.dev/implementors/features.
-	// "features": {},
-
-	// 👇 Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-
-	// 👇 Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "cat /usr/local/etc/greeting.txt"
-
-	// 👇 Configure tool-specific properties.
-	// "customizations": {},
-
-	// 👇 Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-	// "remoteUser": "root"
-}
diff --git a/src/hello/devcontainer-template.json b/src/hello/devcontainer-template.json
deleted file mode 100644
index 342c75e..0000000
--- a/src/hello/devcontainer-template.json
+++ /dev/null
@@ -1,34 +0,0 @@
-{
-    "id": "hello",
-    "version": "1.0.0",
-    "name": "Hello, World",
-    "description": "A hello world Template",
-    "documentationURL": "https://github.com/devcontainers/template-starter/tree/main/src/hello",
-    "licenseURL": "https://github.com/devcontainers/template-starter/blob/main/LICENSE",
-    "options": {
-        "imageVariant": {
-            "type": "string",
-            "description": "Ubuntu version (use ubuntu-22.04 or ubuntu-18.04 on local arm64/Apple Silicon):",
-            "proposals": [
-                "jammy",
-                "focal",
-                "bionic"
-            ],
-            "default": "jammy"
-        },
-        "greeting": {
-            "type": "string",
-            "description": "Select a pre-made greeting, or enter your own",
-            "proposals": [
-                "hey",
-                "hello",
-                "hi",
-                "howdy"
-            ],
-            "default": "hey"
-        }
-    },
-    "platforms": [
-        "Any"
-    ]
-}
diff --git a/src/hello/.devcontainer/Dockerfile b/src/nvim-java/.devcontainer/Dockerfile
similarity index 100%
rename from src/hello/.devcontainer/Dockerfile
rename to src/nvim-java/.devcontainer/Dockerfile
diff --git a/src/nvim-java/.devcontainer/devcontainer.json b/src/nvim-java/.devcontainer/devcontainer.json
new file mode 100644
index 0000000..3f5207a
--- /dev/null
+++ b/src/nvim-java/.devcontainer/devcontainer.json
@@ -0,0 +1,24 @@
+{
+  "name": "nvim-java",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  // 👇 Features to add to the Dev Container. More info: https://containers.dev/implementors/features.
+  "features": {
+    "ghcr.io/s1n7ax/devcontainer-features/neovim-essentials:2": {},
+    "ghcr.io/s1n7ax/devcontainer-features/neovim:2": {},
+    "ghcr.io/devcontainers/features/java:1": {
+      "version": "23",
+      "installGradle": true,
+      "installMaven": true
+    }
+  },
+  // 👇 Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // 👇 Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "cat /usr/local/etc/greeting.txt"
+  // 👇 Configure tool-specific properties.
+  // "customizations": {},
+  // 👇 Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}
diff --git a/src/nvim-java/devcontainer-template.json b/src/nvim-java/devcontainer-template.json
new file mode 100644
index 0000000..7d73679
--- /dev/null
+++ b/src/nvim-java/devcontainer-template.json
@@ -0,0 +1,34 @@
+{
+  "id": "nvim-java",
+  "version": "1.0.0",
+  "name": "Java with Neovim",
+  "description": "A Java development environment with Neovim",
+  "documentationURL": "https://github.com/devcontainers/template-starter/tree/main/src/hello",
+  "licenseURL": "https://github.com/devcontainers/template-starter/blob/main/LICENSE",
+  "options": {
+    "imageVariant": {
+      "type": "string",
+      "description": "Ubuntu version (use ubuntu-22.04 or ubuntu-18.04 on local arm64/Apple Silicon):",
+      "proposals": [
+        "jammy",
+        "focal",
+        "bionic"
+      ],
+      "default": "jammy"
+    },
+    "greeting": {
+      "type": "string",
+      "description": "Select a pre-made greeting, or enter your own",
+      "proposals": [
+        "hey",
+        "hello",
+        "hi",
+        "howdy"
+      ],
+      "default": "hey"
+    }
+  },
+  "platforms": [
+    "Any"
+  ]
+}
diff --git a/test/hello/test.sh b/test/nvim-java/test.sh
similarity index 100%
rename from test/hello/test.sh
rename to test/nvim-java/test.sh