Skip to content

Commit

Permalink
build: change devcontainer
Browse files Browse the repository at this point in the history
  • Loading branch information
marksie1988 committed Oct 16, 2023
1 parent 7c09315 commit be1a9f4
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Atomic Calendar Revive",
"dockerFile": "Dockerfile",
"context": "..",
"image": "totaldebug/bugbox:typescript",
"postCreateCommand": "zsh ./.devcontainer/post-install.sh",
"customizations": {
"vscode": {
"settings": {
Expand All @@ -24,9 +24,9 @@
"ms-python.python",
"tht13.html-preview-vscode",
"sourcery.sourcery",
"tabnine.tabnine-vscode"
"tabnine.tabnine-vscode",
"trond-snekvik.simple-rst"
]
}
},
"postCreateCommand": "zsh ./.devcontainer/post-install.sh"
}
}
3 changes: 0 additions & 3 deletions .devcontainer/post-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ WORKSPACE_DIR=$(pwd)
# Now install all dependencies
yarn install

# Install Commitizen globally
npm install commitizen -g

# Install documentation dependencies
pip3 install -r docs/requirements.txt
pip3 install sphinx-autobuild pre-commit
Expand Down
9 changes: 0 additions & 9 deletions .devcontainer/recommended-Dockerfile

This file was deleted.

3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ dist/*
!dist/atomic-calendar-revive.js

.devcontainer/*
!.devcontainer/recommended-devcontainer.json
!.devcontainer/recommended-Dockerfile
!.devcontainer/devcontainer.json
!.devcontainer/post-install.sh
dist

Expand Down
25 changes: 8 additions & 17 deletions docs/contribute/devcontainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,16 @@ Requirements

* VS Code
* Docker
* Remote - Containers (VS Code extension)
* Remote Development (VS Code extension pack)


*************
Configuration
*************
*****
Usage
*****

#. Copy the files inside ``.devcontainer``
#. Paste them in the same folder, renaming to remove the ``recommended-``
#. In most cases no other changes will be required with these files
#. Open VS Code
#. Open the command pallete and type: ``Dev Continers: Clone repository in container volume``

.. note::
Please ensure that the ``recommended-xxx`` files are not removed as this would remove
them from the repository
This will then clone the repository directly into the development container and install
all the recommended plugins. You can then start development without any further configuration

When you open the repository with VS Code, a prompt to "Reopen in container" should
now appear. This will start the build of the development container with all components
and extensions pre-installed.

.. note::
If you don't see the notification, open the command pallet and select
``Remote-Containers: Open Folder in Container``
2 changes: 1 addition & 1 deletion docs/contribute/devcycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Setup Repository
****************

* Fork the repo in `github <https://github.com/totaldebug/atomic-calendar-revive>`_
* Clone the project to your development machine
* Clone the project to your development machine (or follow the DevContainer instructions)

.. code-block:: bash
Expand Down

0 comments on commit be1a9f4

Please sign in to comment.