Skip to content

Commit 188582b

Browse files
authored
Initial commit
0 parents  commit 188582b

File tree

5 files changed

+112
-0
lines changed

5 files changed

+112
-0
lines changed

.github/workflows/publish-feature.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Publish feature
2+
on:
3+
release:
4+
types: published
5+
workflow_dispatch:
6+
concurrency:
7+
group: ${{ github.workflow }}
8+
cancel-in-progress: true
9+
jobs:
10+
permissions:
11+
contents: read
12+
packages: write
13+
publish-feature:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: devcontainers-community/publish-feature@v1

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 YOUR_NAME
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Dev Containers single Feature starter kit
2+
3+
🚀 Quickstart to create your own singular Dev Container Feature
4+
5+
<p align=center>
6+
<img src=>
7+
</p>
8+
9+
## Usage
10+
11+
<img align=right src=https://i.imgur.com/woHa37r.png>
12+
13+
**Click <kbd>Use this template</kbd>!** That's the first step. After instantiating this template repo, there are a few things you'll need to do manually:
14+
15+
1. Change the name in the `LICENSE` file to be your name or your organization's name. Right now it's `YOUR_NAME`.
16+
17+
2. Change or remove the banner image in the lower part of this readme. Don't worry, a banner image isn't required.
18+
19+
3. Change the example from `"ghcr.io/octocat/features/i-am-awesome:1": {}` to your own name and feature name.
20+
21+
4. Change any of the other readme text to match your own new awesome feature. 🚀
22+
23+
5. Remove the top part of this `README.md` file. You don't want this template guide showing up on your own awesome feature, do you? 😉
24+
25+
---
26+
<!-- REMOVE THIS LINE AND EVERYTHING ABOVE -->
27+
28+
# I am awesome Dev Container Feature
29+
30+
🤩 Tells you that **you are awesome** when you start your Dev Container!
31+
32+
<p align=center>
33+
<img width=400 src=https://i.imgur.com/7On7iXn.png>
34+
</p>
35+
36+
Uses the `postAttachCommand` to tell you that **you are awesome** whenever you start the Dev Container. ❤️
37+
38+
## Usage
39+
40+
```jsonc
41+
// devcontainer.json
42+
{
43+
"features": {
44+
"ghcr.io/octocat/features/i-am-awesome:1": {}
45+
}
46+
}
47+
```
48+
49+
❓ Don't know what this ☝ means? Check out [this VS Code blog post].
50+
51+
### Options
52+
53+
There are currently no options. If you'd like to add a `version` option, open an
54+
Issue or a PR! ❤️
55+
56+
<!-- prettier-ignore -->
57+
[this vs code blog post]: https://code.visualstudio.com/blogs/2022/09/15/dev-container-features

devcontainer-feature.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"id": "i-am-awesome",
3+
"name": "I am awesome",
4+
"documentationURL": "https://github.com/octocat/i-am-awesome#readme",
5+
"licenseURL": "https://github.com/octocat/i-am-awesome/blob/main/LICENSE",
6+
"options": {}
7+
}

install.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/bin/bash
2+
set -ex
3+
4+
cat <<EOF
5+
----------------------------------------------
6+
7+
YOU ARE AWESOME!
8+
9+
----------------------------------------------
10+
EOF

0 commit comments

Comments
 (0)