Skip to content

Add instructions for using vscode.dev #258

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.

Sign up for GitHub

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

Open
m-houston wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −1
Open

Add instructions for using vscode.dev #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
"**/.DS_Store": true,
"**/Thumbs.db": true,
"**/.ruby-lsp": true,
"docs": true,
".devcontainer": true,
".github": true,
".vscode": false,
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#### Setup guides

- [Making changes via vscode.dev](setup/vscode-dev.md)
- [GPG setup for Codespaces](setup/gpg.md)
- [First-time Codespaces setup](setup/codespaces.md)
- [GitHub Copilot quick start](setup/copilot.md)
Expand Down
30 changes: 30 additions & 0 deletions setup/vscode-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Edit `NHSDigital/nhs-notify-web-cms` in the browser

1. Open [github.dev/NHSDigital/nhs-notify-web-cms](https://github.dev/NHSDigital/nhs-notify-web-cms).
2. Sign in to GitHub when prompted.
3. Click the branch name in the lower-left corner, then create a new branch (for example, `yourname/content-update`).
4. Edit and save the required files.
5. Open **Source Control** (branch icon), review the diff, stage the intended files, enter a clear commit message, and select **Commit & Push**.
6. Open GitHub and create a pull request from your branch.

## Signing

`vscode.dev` is a browser editor, not a full development machine: it does not provide a normal Git terminal or local signing-key setup.

- For commit verification, GitHub automatically signs commits made through its web interface. For a `vscode.dev` commit, check the resulting commit on GitHub; it should show **Verified** if GitHub signed it.

## Testing the output

**Recommended: GitHub Codespaces.** From `vscode.dev`, click on the Run and Debug tab, then use **Continue Working On → Create New Codespace**.
It provides a real Linux VM, terminal, dependencies, ports, and a browser preview. Enable **GPG verification** in GitHub Codespaces settings as verified commits are required.

Use a GitHub Codespace to test changes before opening the pull request:

1. Create or open a Codespace for `NHSDigital/nhs-notify-web-cms`.
2. Check out the branch you created in `vscode.dev`.
3. Install dependencies and copy/configure any required environment variables or secrets.
4. Run the project’s documented checks and local development command.
5. Open the forwarded preview URL, test the affected CMS pages or content, then commit/push any fixes.
6. Create the pull request only after the local checks and preview behave as expected.

If the branch was created in `vscode.dev`, it must be pushed first; then select that branch when creating the Codespace.
Loading