Skip to content

Commit

Permalink
update docs about git workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
sestinj committed Nov 10, 2024
1 parent b6c2b71 commit 719f398
Show file tree
Hide file tree
Showing 7 changed files with 1,919 additions and 1,182 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

## Checklist

- [] The base branch of this PR is `dev`, rather than `main`
- [] The relevant docs, if any, have been updated or created

## Screenshots
Expand Down
19 changes: 0 additions & 19 deletions .github/workflows/README.md

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/dev_pr.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Dev PR checks
name: PR checks

on:
pull_request:
branches:
- dev
- main

jobs:
tsc-check:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ jobs:
git config --local user.name "GitHub Action"
- name: Pull latest changes
run: git pull origin dev
run: git pull origin main

# 1. Download the artifacts
- uses: actions/download-artifact@v4
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/ts-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
pull_request:
branches:
- main
- preview

jobs:
tsc-check:
Expand Down
14 changes: 6 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- [🧑‍💻 Contributing Code](#-contributing-code)
- [Environment Setup](#environment-setup)
- [Pre-requisites](#pre-requisites)
- [Fork the Continue Repository with All Branches](#fork-the-continue-repository-with-all-branches)
- [Fork the Continue Repository with All Branches](#fork-the-continue-repository)
- [VS Code](#vs-code)
- [Debugging](#debugging)
- [JetBrains](#jetbrains)
Expand Down Expand Up @@ -94,8 +94,6 @@ This will start a local server and you can see the documentation rendered in you

## 🧑‍💻 Contributing Code

> Please make PRs to the `dev` branch. We use this to first test changes in a pre-release version of the extension.
### Environment Setup

#### Pre-requisites
Expand All @@ -106,15 +104,15 @@ You should have Node.js version 20.11.0 (LTS) or higher installed. You can get i
nvm use
```

#### Fork the Continue Repository with All Branches
#### Fork the Continue Repository

1. Go to the [Continue GitHub repository](https://github.com/continuedev/continue) and fork it to your GitHub account. **Ensure all branches are included in the fork**.
1. Go to the [Continue GitHub repository](https://github.com/continuedev/continue) and fork it to your GitHub account.

2. Clone your forked repository to your local machine. Use: `git clone https://github.com/YOUR_USERNAME/continue.git`

3. Navigate to the cloned directory and switch to the **dev** branch. Execute: `git checkout dev`, then create your feature/fix branch from there, like so: `git checkout -b 123-my-feature-branch`
3. Navigate to the cloned directory and make sure you are on the main branch. Create your feature/fix branch from there, like so: `git checkout -b 123-my-feature-branch`

4. When you're ready to submit your changes, send your pull request specifically to the **dev** branch.
4. Send your pull request to the main branch.

#### VS Code

Expand Down Expand Up @@ -145,7 +143,7 @@ See the [`CONTRIBUTING.md`](./extensions/intellij/CONTRIBUTING.md) for the JetBr

### Our Git Workflow

We keep two permanent branches: `main` and `dev`. All contributions should be made as pull requests to the `dev` branch. When we are ready to create a "pre-release" version, we create a tag on the `dev` branch, which automatically triggers the workflow in [preview.yaml](./.github/workflows/preview.yaml), which builds and releases a version of the VS Code extension. When a release has been sufficiently tested, we will merge its tag into the `main` branch. Creating a tag on the `main` branch will then trigger a similar workflow in [main.yaml](./.github/workflows/main.yaml), which will build and release a main release of the VS Code extension. Any hotfixes can be made by creating a feature branch from the tag for the release in question.
We keep a single permanent branch: `main`. When we are ready to create a "pre-release" version, we create a tag on the `main` branch titled `v0.9.x-vscode`, which automatically triggers the workflow in [preview.yaml](./.github/workflows/preview.yaml), which builds and releases a version of the VS Code extension. When a release has been sufficiently tested, we will create a new release titled `v0.8.x-vscode`, triggering a similar workflow in [main.yaml](./.github/workflows/main.yaml), which will build and release a main release of the VS Code extension. Any hotfixes can be made by creating a feature branch from the tag for the release in question. This workflow is well explained by http://releaseflow.org.

### Formatting

Expand Down
Loading

0 comments on commit 719f398

Please sign in to comment.