Skip to content

Commit

Permalink
Enhance release workflow with pre-commit hooks and update README for …
Browse files Browse the repository at this point in the history
…new tar.gz format
  • Loading branch information
supcik committed Dec 18, 2024
1 parent ee97832 commit f8cf8d6
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
"zsh",
"./.startup.sh"
]
}
}
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pre-commit/[email protected]
- run: mkdir -p dist
- run: tar czvf ./dist/cc-devcontainer.tar.gz .devcontainer .startup.sh
- run: zip -r dist/cc-devcontainer.zip .devcontainer .startup.sh
Expand Down
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
args: [--allow-multiple-documents]
- id: end-of-file-fixer
- id: trailing-whitespace
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,20 @@
2. Install [Visual Studio Code](https://code.visualstudio.com/)
3. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for Visual Studio Code
4. Create a new folder for your project
5. Download the [boilerplate.zip](https://github.com/heia-fr/cc-devcontainer/releases/latest/download/boilerplate.zip) file and extract it into the folder
5. Download the [cc-devcontainer.tar.gz](https://github.com/heia-fr/cc-devcontainer/releases/latest/download/cc-devcontainer.tar.gz) or [cc-devcontainer.zip](https://github.com/heia-fr/cc-devcontainer/releases/latest/download/cc-devcontainer.zip) file and extract it into the folder
On Unix based systems, you can use the following commands:

```bash
curl -sSfLo - https://github.com/heia-fr/cc-devcontainer/releases/latest/download/cc-devcontainer.tar.gz | tar xvf -
```
6. Check that you have the following files in your project folder:

```
.
├── .devcontainer
│   ├── Dockerfile
│   └── devcontainer.json
└── .startup.sh
```
7. Open the project folder in Visual Studio Code
8. Click on the green button in the bottom left corner of the window and select "Reopen in Container"

0 comments on commit f8cf8d6

Please sign in to comment.