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 vscode task that build project #2207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
@@ -1,5 +1,5 @@
{
"python.pythonPath": "venv/bin/python3",
"python.defaultInterpreterPath": ".venv/bin/python3",
"python.testing.pytestEnabled": true,
"python.testing.autoTestDiscoverOnSaveEnabled": true
}
41 changes: 28 additions & 13 deletions .vscode/tasks.json
Expand Up @@ -4,30 +4,45 @@
"version": "2.0.0",
"tasks": [
{
"label": "Setup step 1: python venv",
"label": "Step 1: Install poetry",
"type": "shell",
"command": "python3 -m venv ./venv",
"windows": {
"command": "python venv"
},
"group": "Setup",
"command": "python3 -m pip install poetry",
"group": "build",
"presentation": {
"reveal": "always",
"panel": "new"
},
"runOptions": {
"runOn": "folderOpen"
}
},
{
"label": "Setup step 2: python requirements",
"label": "Step 2: Configure poetry",
"type": "shell",
"command": "pip3 install -r requirements.txt",
"windows": {
"command": "python requirements"
"command": "poetry config virtualenvs.in-project true --local",
"group": "build",
"presentation": {
"reveal": "always",
"panel": "new"
},
"runOptions": {
"runOn": "folderOpen"
},
"group": "Setup",
"dependsOn": ["Step 1: Install poetry"]
},
{
"label": "Step 3: Install deps",
"type": "shell",
"command": "poetry install",
"group": "build",
"presentation": {
"reveal": "always",
"panel": "new"
}
}
},
"runOptions": {
"runOn": "folderOpen"
},
"dependsOn": ["Step 1: Install poetry", "Step 2: Configure poetry"]
},
]
}
20 changes: 11 additions & 9 deletions docs/developing/index.md
Expand Up @@ -2,17 +2,17 @@

## Get Docker

Development requires Docker desktop available for windows + and mac or Docker CE available for Linux. Visit (Docker)[https://www.docker.com/get-started]
Development requires Docker desktop available for windows + and mac or Docker CE available for Linux. Visit [Docker](https://www.docker.com/get-started)
for download instructions

## Setup VS Code IDE

VS Code provides a free IDE experience that is effective for daily development with SC4S. Visit (Microsoft)[https://code.visualstudio.com/docs/introvideos/basics]
VS Code provides a free IDE experience that is effective for daily development with SC4S. Visit [Microsoft](https://code.visualstudio.com/docs/introvideos/basics)
to download and install for your platform (windows/mac/linux)

## Fork and Clone the github repository

Visit our repository at (Github)[https://github.com/splunk/splunk-connect-for-syslog] and "fork" our repository. This will allow you to make changes and submit pull requests.
Visit our repository at [Github](https://github.com/splunk/splunk-connect-for-syslog) and "fork" our repository. This will allow you to make changes and submit pull requests.

![How to Fork](gh_fork.png)

Expand All @@ -24,16 +24,18 @@ Click the clone icon and select the location

The following steps are required _only_ on the first time run.

* Install VS Code Extensions S
* Install VS Code Extensions:
* Python
* Test Explorer
* "Python Test Explorer"
* From the terminal menu select "Run Task"
* Select "Setup step 1: python venv" then "go without scanning output"
* From the terminal menu select "Run Task"
* Select "Setup step 2: python requirements" then "go without scanning output"

![VS Code setup](vsc_run.png)
* Run command to setup the project:
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
* Select "Step 1: Install poetry"
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
* Select "Step 2: Configure poetry"
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
* Select "Step 3: Install deps"

## Click the test lab icon

Expand Down
2 changes: 1 addition & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.