You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-24Lines changed: 25 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -170,7 +170,9 @@ If this is your first contribution to GitLens, please give yourself credit by ad
170
170
171
171
## Publishing
172
172
173
-
### Versioning
173
+
### Stable Releases
174
+
175
+
#### Versioning
174
176
175
177
GitLens version changes are bucketed into two types:
176
178
@@ -179,40 +181,39 @@ GitLens version changes are bucketed into two types:
179
181
180
182
<small>Note: `major` version bumps are only considered for more special circumstances.</small>
181
183
182
-
#### Updating the CHANGELOG
183
-
184
-
All recent changes are listed under `## [Unreleased]`. This title and corresponding link at the bottom of the page will need to be updated.
185
-
186
-
The title should be updated to the upcoming version and the release date (YYYY-MM-DD):
184
+
#### Preparing
187
185
188
-
```markdown
189
-
<!-- from: -->
186
+
Use the [prep-release](scripts/prep-release.js) script to prepare a new release. The script updates the [package.json](package.json) and [CHANGELOG.md](CHANGELOG.md) appropriately, commits the changes as `Bumps to v<major.minor.patch>`, and creates a `v<major.minor.patch>` tag which when pushed will trigger the CI to publish a release.
190
187
191
-
## [Unreleased]
188
+
1. Ensure you are on a clean working tree
189
+
2. Run `yarn run prep-release` and enter the desired version when prompted.
190
+
3. Review the `Bumps to v<major.minor.patch>` commit
191
+
4. Run `git push --follow-tags` to push the commit and tag
192
192
193
-
<!-- to: -->
194
-
195
-
## [12.1.0] - 2022-06-14
196
-
```
193
+
Pushing the `v<major.minor.patch>` tag will trigger the [Publish Stable workflow](.github/workflows/cd-stable.yml) to automatically package the extension, create a [GitHub release](https://github.com/gitkraken/vscode-gitlens/releases/latest), and deploy it to the [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens).
197
194
198
-
Stage this file so it will be included with the version commit.
195
+
If the action fails and retries are unsuccessful, the VSIX can be built locally with `yarn package` and uploaded manually to the marketplace. A GitHub release can also be [created manually](https://github.com/gitkraken/vscode-gitlens/releases/new) using `v<major.minor.patch>` as the title and the notes from the [CHANGELOG.md](CHANGELOG.md) with the VSIX attached.
199
196
200
-
#### Version Commit
197
+
###Pre-releases
201
198
202
-
Run `yarn version` and enter the upcoming version when prompted.
199
+
The [Publish Pre-release workflow](.github/workflows/cd-pre.yml) is automatically run every AM unless no new changes have been committed to `main`.
203
200
204
-
Once the commit is completed, run `git push --follow-tags` to push the version commit and the newly generated tags.
201
+
### Insiders (deprecated use pre-release instead)
205
202
206
-
### GitHub Actions and Deployment
203
+
The Publish Insiders workflow is no longer available and was replaced with the pre-release edition.
207
204
208
-
After the version commit and new tags are pushed to GitHub, the [Publish Stable workflow](.github/workflows/cd-stable.yml) will be triggered, which will automatically package the extension and deploy it to the [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens). The [release notes](https://github.com/gitkraken/vscode-gitlens/releases/latest)_should_ be generated during the action, but if not, this can be done manually using the notes from the [Change Log](CHANGELOG.md).
205
+
## Updating GL Icons
209
206
210
-
If the action fails, the VSIX will need to be built locally with `yarn package` and uploaded manually in the marketplace.
207
+
To add new icons to the GL Icons font follow the steps below:
211
208
212
-
### Pre-release edition
209
+
- Add new SVG icons to the `images/icons` folder
210
+
- Update the `images/icons/template/mapping.json` file with entries for the new icons (append to the end of the file)
211
+
- Optimize and build the icons by running the following from a terminal:
213
212
214
-
The [Publish Pre-release workflow](.github/workflows/cd-pre.yml) is automatically run every AM unless no new changes have been committed to `main`.
213
+
```
214
+
yarn run icons:svgo
215
+
yarn run build:icons
215
216
216
-
### Insiders edition (deprecated use pre-release instead)
217
+
```
217
218
218
-
The Publish Insiders workflow is no longer available and was replaced with the pre-release edition.
219
+
Once you've finshed copy the new `glicons.woff2?<uuid>` URL from `src/webviews/apps/shared/glicons.scss`and search and replace the old references with the new one.
Copy file name to clipboardExpand all lines: README.md
+14-11Lines changed: 14 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -23,13 +23,13 @@ Use `Switch to Pre-Release Version` on the extension banner to live on the edge
23
23
All features are free to use on all repos, **except** for features,
24
24
25
25
- marked with a ✨ require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately hosted repos
26
-
- marked with a ☁️ require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
26
+
- marked with a ☁️ require a GitKraken account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
27
27
28
28
See the [FAQ](#is-gitlens-free-to-use'Jump to FAQ') for more details.
29
29
30
30
[Features](#discover-powerful-features'Jump to Discover Powerful Features')
31
31
| [Labs](#gitkraken-labs'Jump to GitKraken Labs')
32
-
| [Pro](#ready-for-gitlens-pro'Jump to Ready for GitLens Pro?')
32
+
| [Pro](#ready-for-gitlens-pro'Jump to Ready for GitKraken Pro?')
33
33
| [FAQ](#faq'Jump to FAQ')
34
34
| [Support and Community](#support-and-community'Jump to Support and Community')
35
35
| [Contributing](#contributing'Jump to Contributing')
@@ -179,10 +179,10 @@ Use the rich commit search to find exactly what you're looking for. Its powerful
179
179
180
180
GitKraken Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow. Create workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration.
181
181
182
-
The Focus view brings all of your GitHub pull requests and issues into a unified actionable view to help to you more easily juggle work in progress, pending work, reviews, and more. Quickly see if anything requires your attention while keeping you focused.
182
+
Focus brings all of your GitHub pull requests and issues into a unified actionable view to help to you more easily juggle work in progress, pending work, reviews, and more. Quickly see if anything requires your attention while keeping you focused.
@@ -227,7 +227,7 @@ A guided, step-by-step experience for quickly and safely executing Git commands.
227
227
228
228
Use a series of new commands to:
229
229
230
-
-Expore the commit history of branches and files
230
+
-Explore the commit history of branches and files
231
231
- Quickly search for and navigate to (and action upon) commits
232
232
- Explore a file of a commit
233
233
- View and explore your stashes
@@ -257,11 +257,11 @@ Use the Explain panel on the **Commit Details** view to leverage AI to help you
257
257
258
258
Use the `Generate Commit Message` command from the Source Control view's context menu to automatically generate a commit message for your staged changes by leveraging AI.
259
259
260
-
# Ready for GitLens Pro?
260
+
# Ready for GitKraken Pro?
261
261
262
-
When you're ready to unlock the full potential of GitLens and enjoy all the benefits on your privately hosted repos, consider upgrading to GitLens Pro. With GitLens Pro, you'll gain access to ✨ features on privately hosted repos and ☁️ features based on the Pro plan.
262
+
When you're ready to unlock the full potential of GitLens and enjoy all the benefits on your privately hosted repos, consider upgrading to GitKraken Pro. With GitKraken Pro, you'll gain access to ✨ features on privately hosted repos and ☁️ features based on the Pro plan.
263
263
264
-
To learn more about the pricing and the additional ✨ and ☁️ features offered with GitLens Pro, visit the [GitLens Pricing page](https://www.gitkraken.com/gitlens/pricing). Upgrade to GitLens Pro today and take your Git workflow to the next level!
264
+
To learn more about the pricing and the additional ✨ and ☁️ features offered with GitKraken Pro, visit the [GitLens Pricing page](https://www.gitkraken.com/gitlens/pricing). Upgrade to GitKraken Pro today and take your Git workflow to the next level!
265
265
266
266
# FAQ
267
267
@@ -272,9 +272,9 @@ Yes. All features are free to use on all repos, **except** for features,
272
272
- marked with a ✨ require a [trial or paid plan](https://www.gitkraken.com/gitlens/pricing) for use on privately hosted repos
273
273
- marked with a ☁️ require a GitKraken Account, with access level based on your [plan](https://www.gitkraken.com/gitlens/pricing), e.g. Free, Pro, etc
274
274
275
-
While GitLens offers a remarkable set of free features, a subset of features tailored for professional developers and teams, marked with a ✨, require a trial or paid plan for use on privately hosted repos — use on local or publicly hosted repos is free for everyone. Additionally some features marked with a ☁️, rely on GitKraken Dev Services which requires an account and access is based on your plan, e.g. Free, Pro, etc.
275
+
While GitLens offers a remarkable set of free features, a subset of features tailored for professional developers and teams, marked with a ✨, require a trial or paid plan for use on privately hosted repos — use on local or publicly hosted repos is free for everyone. Additionally some features marked with a ☁️, rely on GitKraken Dev Services which requires a GitKraken account and access is based on your plan, e.g. Free, Pro, etc.
276
276
277
-
Preview ✨ features instantly for free for 3 days without an account, or start a free Pro trial to get an additional 7 days and gain access to ☁️ features to experience the full power of GitLens.
277
+
Preview ✨ features instantly for free for 3 days without an account, or start a free GitKraken trial to get an additional 7 days and gain access to ☁️ features to experience the full power of GitLens.
278
278
279
279
## Are ✨ and ☁️ features free to use?
280
280
@@ -300,7 +300,7 @@ Join the GitLens community on [GitHub Discussions](https://github.com/gitkraken/
300
300
301
301
For any issues or inquiries related to GitLens, you can reach out to the GitKraken support team via the [official support page](https://support.gitkraken.com/). They will be happy to assist you with any problems you may encounter.
302
302
303
-
With GitLens Pro, you gain access to priority email support from our customer success team, ensuring higher priority and faster response times. Custom onboarding and training are also available to help you and your team quickly get up and running with a GitLens Pro plan.
303
+
With GitKraken Pro, you gain access to priority email support from our customer success team, ensuring higher priority and faster response times. Custom onboarding and training are also available to help you and your team quickly get up and running with a GitKraken Pro plan.
304
304
305
305
# Contributing
306
306
@@ -345,6 +345,7 @@ A big thanks to the people that have contributed to this project 🙏❤️:
- John Gee ([@shadowspawn](https://github.com/shadowspawn)) —[contributions](https://github.com/gitkraken/vscode-gitlens/commits?author=shadowspawn)
- Allan Karlson ([@bees4ever](https://github.com/bees4ever)) —[contributions](https://github.com/gitkraken/vscode-gitlens/commits?author=bees4ever)
- Mathew King ([@MathewKing](https://github.com/MathewKing)) —[contributions](https://github.com/gitkraken/vscode-gitlens/commits?author=MathewKing)
@@ -385,6 +387,7 @@ A big thanks to the people that have contributed to this project 🙏❤️:
0 commit comments