diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4e76430..78ed71d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,6 +1,10 @@ +name: Tests + on: push: pull_request: + schedule: + - cron: "0 0 15 * *" jobs: build: diff --git a/DEVELOP.md b/DEVELOP.md index f9f62cf..65c8229 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -1,6 +1,6 @@ # Developing this extension -Thank you for your interest in helping develop this extension. If you're new to developing VSCode extensions, then you may want to try and follow the quickstart below. If something doesn't work, feel free to open an issue or submit a PR fixing this documentation! +Thank you for your interest in helping develop this extension. To get up and running, follow the guide below. If something doesn't work, feel free to open an issue or submit a PR fixing this documentation! ## Quickstart @@ -13,18 +13,22 @@ Thank you for your interest in helping develop this extension. If you're new to 1. You can manually test your changes by navigating to "Run and Debug" -> "Run Extension" -> green arrow. This opens a sandboxed version of vscode with your updated extension. 1. You should add unit tests for your functionality as well. These go under `src/test/suite`, or in `src/lib.rs` if you are modifying the rust code. *Your PR will likely not be merged without unit tests.* -# Release check list +# Maintaining this extension + +The following items are relevant if you are actively maintaining this extension. I wrote this documentation for myself, since I have to do these maintenance actions approximately once a year at this point. + +## Release check list You will need [`vsce`](https://github.com/Microsoft/vscode-vsce) installed. -If it has expired, get a new token. Follow the instructions [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token). +If needed, get a new access token. Follow the instructions [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token). 1. The [CHANGELOG](./CHANGELOG.md) has been updated. -1. `git checkout master` +1. `git checkout main` 1. `git pull` 1. Smoke test (run extension through debugger, open `smoke_test.py`, press `enter` after each line and make sure it looks good). -1. CI has passed on the master branch. -1. `vsce publish {patch,minor,major}` +1. CI has passed on the main branch. +1. `vsce publish {patch,minor,major}` and optionally use the `--pre-release` argumentvs 1. `vsce package` 1. `git push; git push --tags` 1. On GitHub, draft a release using the existing tag that was created by the `publish` command. @@ -32,10 +36,10 @@ If it has expired, get a new token. Follow the instructions [here](https://code. 1. Attach the `.vsix` artifact created by the `package` command to the draft release. 1. Publish the release. -# Getting CI to work +## Getting CI to work -... +Follow the instructions [here](https://code.visualstudio.com/api/working-with-extensions/continuous-integration#github-actions). -# Extension reporting hub +## Extension reporting hub https://marketplace.visualstudio.com/manage/publishers/kevinrose/extensions/vsc-python-indent/hub (requries login) diff --git a/README.md b/README.md index 832e0f2..c7524bd 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,8 @@ Correct Python indentation in Visual Studio Code. See the extension on the [VSCo Theme shown is _Community Theme Palenight_ from [_Community Material Theme_](https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-community-material-theme) v1.4.4. -[![Build Status](https://dev.azure.com/kevinbrose/vsc-python-indent/_apis/build/status/vsc-python-indent-CI?branchName=master)](https://dev.azure.com/kevinbrose/vsc-python-indent/_build/latest?definitionId=1&branchName=master) +[![Build Status](https://github.com/kbrose/vsc-python-indent/actions/workflows/ci.yml/badge.svg)](https://github.com/kbrose/vsc-python-indent/actions?query=branch%3Amain) [![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/KevinRose.vsc-python-indent)](https://marketplace.visualstudio.com/items?itemName=KevinRose.vsc-python-indent) -[![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/KevinRose.vsc-python-indent)](https://marketplace.visualstudio.com/items?itemName=KevinRose.vsc-python-indent) ## How it works