generated from devcontainers-community/feature-starter
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 188582b
Showing
5 changed files
with
112 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: Publish feature | ||
on: | ||
release: | ||
types: published | ||
workflow_dispatch: | ||
concurrency: | ||
group: ${{ github.workflow }} | ||
cancel-in-progress: true | ||
jobs: | ||
permissions: | ||
contents: read | ||
packages: write | ||
publish-feature: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: devcontainers-community/publish-feature@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 YOUR_NAME | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Dev Containers single Feature starter kit | ||
|
||
🚀 Quickstart to create your own singular Dev Container Feature | ||
|
||
<p align=center> | ||
<img src=> | ||
</p> | ||
|
||
## Usage | ||
|
||
<img align=right src=https://i.imgur.com/woHa37r.png> | ||
|
||
**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: | ||
|
||
1. Change the name in the `LICENSE` file to be your name or your organization's name. Right now it's `YOUR_NAME`. | ||
|
||
2. Change or remove the banner image in the lower part of this readme. Don't worry, a banner image isn't required. | ||
|
||
3. Change the example from `"ghcr.io/octocat/features/i-am-awesome:1": {}` to your own name and feature name. | ||
|
||
4. Change any of the other readme text to match your own new awesome feature. 🚀 | ||
|
||
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? 😉 | ||
|
||
--- | ||
<!-- REMOVE THIS LINE AND EVERYTHING ABOVE --> | ||
|
||
# I am awesome Dev Container Feature | ||
|
||
🤩 Tells you that **you are awesome** when you start your Dev Container! | ||
|
||
<p align=center> | ||
<img width=400 src=https://i.imgur.com/7On7iXn.png> | ||
</p> | ||
|
||
Uses the `postAttachCommand` to tell you that **you are awesome** whenever you start the Dev Container. ❤️ | ||
|
||
## Usage | ||
|
||
```jsonc | ||
// devcontainer.json | ||
{ | ||
"features": { | ||
"ghcr.io/octocat/features/i-am-awesome:1": {} | ||
} | ||
} | ||
``` | ||
|
||
❓ Don't know what this ☝ means? Check out [this VS Code blog post]. | ||
|
||
### Options | ||
|
||
There are currently no options. If you'd like to add a `version` option, open an | ||
Issue or a PR! ❤️ | ||
|
||
<!-- prettier-ignore --> | ||
[this vs code blog post]: https://code.visualstudio.com/blogs/2022/09/15/dev-container-features |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"id": "i-am-awesome", | ||
"name": "I am awesome", | ||
"documentationURL": "https://github.com/octocat/i-am-awesome#readme", | ||
"licenseURL": "https://github.com/octocat/i-am-awesome/blob/main/LICENSE", | ||
"options": {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
#!/bin/bash | ||
set -ex | ||
|
||
cat <<EOF | ||
---------------------------------------------- | ||
YOU ARE AWESOME! | ||
---------------------------------------------- | ||
EOF |