Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #10

Merged
merged 3 commits into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"features",
"publish",
"--namespace",
"deep-space-cartel/devcontainers-features",
"deepspacecartel/devcontainers-features",
"src/"
],
"group": {
Expand All @@ -44,7 +44,7 @@
"features",
"generate-docs",
"--namespace",
"deep-space-cartel/devcontainers-features",
"deepspacecartel/devcontainers-features",
"--project-folder",
"src/"
],
Expand Down Expand Up @@ -157,7 +157,7 @@
}
]
},
"dotfiles.repository": "deep-space-cartel/dotfiles",
"dotfiles.repository": "deepspacecartel/dotfiles",
"editor.fontFamily": "'Hack Nerd Font Mono'",
"files.insertFinalNewline": true,
"json.schemas": [
Expand All @@ -173,15 +173,15 @@
}
},
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/starship:1": {},
"ghcr.io/deep-space-cartel/devcontainers-features/pip:1": {
"packages": "pre-commit",
"location": "/opt/pip"
},
"ghcr.io/deep-space-cartel/devcontainers-features/apt:1": {
"packages": "shellcheck shfmt mc python3-pip python3-venv"
},
"ghcr.io/devcontainers/features/docker-in-docker:2": {}
// "ghcr.io/deepspacecartel/devcontainers-features/starship:1": {},
// "ghcr.io/deepspacecartel/devcontainers-features/pip:1": {
// "packages": "pre-commit",
// "location": "/opt/pip"
// },
// "ghcr.io/deepspacecartel/devcontainers-features/apt:1": {
// "packages": "shellcheck shfmt mc python3-pip python3-venv"
// },
// "ghcr.io/devcontainers/features/docker-in-docker:2": {}
},
"image": "mcr.microsoft.com/devcontainers/javascript-node:1-20-bookworm",
"remoteEnv": {
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repos:
hooks:
- id: devcontainer-docs
name: "Dev Container Features: Generate Docs"
entry: devcontainer features generate-docs --namespace deep-space-cartel/devcontainers-features --project-folder src/
entry: devcontainer features generate-docs --namespace deepspacecartel/devcontainers-features --project-folder src/
language: system
always_run: true
pass_filenames: false
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dev Container Features

[![CI - Test Features](https://github.com/deep-space-cartel/devcontainers-features/actions/workflows/test.yaml/badge.svg)](https://github.com/deep-space-cartel/devcontainers-features/actions/workflows/test.yaml)
[![CI - Test Features](https://github.com/deepspacecartel/devcontainers-features/actions/workflows/test.yaml/badge.svg)](https://github.com/deepspacecartel/devcontainers-features/actions/workflows/test.yaml)

## Features

Expand All @@ -10,7 +10,7 @@
{
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/apt:latest": {
"ghcr.io/deepspacecartel/devcontainers-features/apt:2": {
"packages": "shellcheck shfmt"
}
}
Expand All @@ -28,9 +28,9 @@ Install `pre-commit` via PIP Installs Packages:
"PATH": "${containerEnv:PATH}:/opt/pip/bin"
},
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/pip:1": {
"ghcr.io/deepspacecartel/devcontainers-features/pip:2": {
"packages": "pre-commit",
"location": "/opt/pip/bin",
"location": "/opt/pip",
}
}
}
Expand All @@ -57,7 +57,7 @@ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
{
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/starship:latest": {
"ghcr.io/deepspacecartel/devcontainers-features/starship:2": {
"version": "latest"
}
}
Expand All @@ -71,7 +71,7 @@ Since `starship` is managed by configuration files in `$HOME` consider using the
"customizations": {
"vscode": {
"settings": {
"dotfiles.repository": "deep-space-cartel/dotfiles"
"dotfiles.repository": "deepspacecartel/dotfiles"
}
}
}
Expand All @@ -84,7 +84,7 @@ If you are using `devcontainers-features/apt` as well then you might have to add
{
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/starship:latest": {
"ghcr.io/deepspacecartel/devcontainers-features/starship:2": {
"version": "latest"
}
}
Expand Down Expand Up @@ -148,7 +148,7 @@ devcontainers-features on  main +/- [😵]

Consider using along with:

* <https://github.com/deep-space-cartel/dotfiles>
* <https://github.com/deepspacecartel/dotfiles>

## Development

Expand All @@ -161,13 +161,13 @@ pre-commit run --hook-stage manual
Upload packages

```bash
devcontainer features publish --namespace deep-space-cartel/devcontainers-features src/
devcontainer features publish --namespace deepspacecartel/devcontainers-features src/
```

Generate docs:

```bash
devcontainer features generate-docs --namespace deep-space-cartel/devcontainers-features --project-folder src/
devcontainer features generate-docs --namespace deepspacecartel/devcontainers-features --project-folder src/
```

## TODO
Expand Down
2 changes: 1 addition & 1 deletion src/apt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install apt packages via JSON or apt.txt

```json
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/apt:1": {}
"ghcr.io/deepspacecartel/devcontainers-features/apt:1": {}
}
```

Expand Down
2 changes: 1 addition & 1 deletion src/apt/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Install package(s) via Advanced Package Tool",
"id": "apt",
"version": "1.1.0",
"version": "2.0.0",
"description": "Install apt packages via JSON or apt.txt",
"options": {
"packages": {
Expand Down
2 changes: 1 addition & 1 deletion src/pip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install Python packages via JSON or requirements.txt

```json
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/pip:1": {}
"ghcr.io/deepspacecartel/devcontainers-features/pip:1": {}
}
```

Expand Down
6 changes: 3 additions & 3 deletions src/pip/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Install package(s) via Pip Installs Packages",
"id": "pip",
"version": "1.0.0",
"version": "2.0.0",
"description": "Install Python packages via JSON or requirements.txt",
"options": {
"location": {
Expand All @@ -23,12 +23,12 @@
}
},
"dependsOn": {
"ghcr.io/deep-space-cartel/devcontainers-features/apt:1": {
"ghcr.io/deepspacecartel/devcontainers-features/apt:1": {
"packages": "python3-pip python3-venv"
}
},
"installsAfter": [
"ghcr.io/devcontainers/features/common-utils",
"ghcr.io/deep-space-cartel/devcontainers-features/apt"
"ghcr.io/deepspacecartel/devcontainers-features/apt"
]
}
2 changes: 1 addition & 1 deletion src/starship/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The minimal, blazing-fast, and infinitely customizable prompt for any shell!

```json
"features": {
"ghcr.io/deep-space-cartel/devcontainers-features/starship:1": {}
"ghcr.io/deepspacecartel/devcontainers-features/starship:1": {}
}
```

Expand Down
4 changes: 2 additions & 2 deletions src/starship/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Starship",
"id": "starship",
"version": "1.2.0",
"version": "2.0.0",
"description": "The minimal, blazing-fast, and infinitely customizable prompt for any shell!",
"options": {
"platform": {
Expand Down Expand Up @@ -32,7 +32,7 @@
},
"dependsOn": {
"ghcr.io/devcontainers/features/common-utils": {},
"ghcr.io/deep-space-cartel/devcontainers-features/apt:1": {
"ghcr.io/deepspacecartel/devcontainers-features/apt:1": {
"packages": "bash-completion"
}
}
Expand Down