Skip to content

Commit

Permalink
Preparing for the big release (#76)
Browse files Browse the repository at this point in the history
* Closes #73

1. Added a release guide to CONTRIBUTING.md.
2. Added a Github action that will publish release to both
   Github releases and VSCode marketplace.
3. Bumped the version to v1.0.0. The changes are huge enough
   to finally call this "v1" :)
4. Made some cosmetic changes to the documentation.
  • Loading branch information
ameshkov authored Apr 24, 2023
1 parent e5a75e9 commit f3520b3
Show file tree
Hide file tree
Showing 6 changed files with 286 additions and 100 deletions.
65 changes: 65 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Release to VSCode Marketplace and GitHub Releases

on:
push:
tags:
- v*

# Workflow need write access to the repository to create a release
permissions:
contents: write

jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v3

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://registry.npmjs.org
cache: yarn

- name: Install dependencies
run: |
# Install VSCE globally
yarn global add @vscode/vsce
# Install dependencies in the root directory
yarn install --ignore-scripts --frozen-lockfile
# Install dependencies in the client directory
cd client
yarn install --ignore-scripts --frozen-lockfile
# Install dependencies in the server directory
cd ../server
yarn install --ignore-scripts --frozen-lockfile
# ESBuild ignores type checking, so we need to run it separately
# before running ESBuild
- name: Check TypeScript types
run: yarn test-compile

- name: Run ESLint
run: yarn lint

# Run ESBuild & generate VSIX file
- name: Pack files with VSCE
run: yarn generate-vsix

- name: Publish to VSCode Marketplace
run: vsce publish -p ${{ secrets.VSCE_TOKEN }} -i vscode-adblock.vsix

- name: Create GitHub Release
uses: softprops/action-gh-release@v1
with:
files: |
vscode-adblock.vsix
draft: false
prerelease: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
101 changes: 54 additions & 47 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
The format is based on [Keep a Changelog][keepachangelog], and this project
adheres to [Semantic Versioning][semver].

## [0.0.29] - 2023-02-06
[keepachangelog]: https://keepachangelog.com/en/1.0.0/
[semver]: https://semver.org/spec/v2.0.0.html

## [1.0.0] - 2023-04-25

### Added

- Added support for VSCode language server and client. This integrates [AGLint](https://github.com/AdguardTeam/AGLint) into this extension. [#24](https://github.com/ameshkov/VscodeAdblockSyntax/issues/24)
- Added support for folding: [#59](https://github.com/ameshkov/VscodeAdblockSyntax/pull/59)
- Added support for VSCode language server and client. This integrates
[AGLint][aglint] into this extension. [#24](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/24)
- Added support for folding: [#59](https://github.com/AdguardTeam/VscodeAdblockSyntax/pull/59)

[aglint]: https://github.com/AdguardTeam/AGLint

### Changed

Expand All @@ -18,66 +25,66 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Fixed

- Fix media queries highlighting: [#56](https://github.com/ameshkov/VscodeAdblockSyntax/issues/56)
- Fix media queries highlighting: [#56](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/56)

## [0.0.28] - 2022-11-11

### Added

- Added support for optional arguments in uBO scriptlets: [#53](https://github.com/ameshkov/VscodeAdblockSyntax/issues/53)
- Added support for `env_legacy` condition: [#52](https://github.com/ameshkov/VscodeAdblockSyntax/issues/52)
- Added support for permissive domain names: [#10](https://github.com/ameshkov/VscodeAdblockSyntax/issues/10)
- Added support for optional arguments in uBO scriptlets: [#53](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/53)
- Added support for `env_legacy` condition: [#52](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/52)
- Added support for permissive domain names: [#10](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/10)

### Fixed

- Fix `!##`-like comments: [#54](https://github.com/ameshkov/VscodeAdblockSyntax/issues/54)
- Fix regex detection: [#51](https://github.com/ameshkov/VscodeAdblockSyntax/issues/51)
- Fix `!##`-like comments: [#54](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/54)
- Fix regex detection: [#51](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/51)

## [0.0.27] - 2022-08-15

### Added

- Added support for adblock agents: [#49](https://github.com/ameshkov/VscodeAdblockSyntax/pull/49)
- Added support for adblock agents: [#49](https://github.com/AdguardTeam/VscodeAdblockSyntax/pull/49)

### Fixed

- Fix redundant modifier detection: [#25](https://github.com/ameshkov/VscodeAdblockSyntax/issues/25)
- Fix redundant modifier detection: [#25](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/25)

## [0.0.26] - 2022-05-29

### Added

- Added support for cosmetic rules modifiers: [#47](https://github.com/ameshkov/VscodeAdblockSyntax/issues/47)
- Added support for cosmetic rules modifiers: [#47](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/47)

## [0.0.25] - 2021-11-11

### Added

- Added support for `Ctrl + /` hotkey to toggle comments: [#46](https://github.com/ameshkov/VscodeAdblockSyntax/issues/46)
- Added support for `Ctrl + /` hotkey to toggle comments: [#46](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/46)

## [0.0.23] - 2021-05-31

### Fixed

- Fixed an issue with `#if` directives marked invalid: [#44](https://github.com/ameshkov/VscodeAdblockSyntax/issues/44)
- Fixed an issue with `#if` directives marked invalid: [#44](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/44)

## [0.0.22] - 2021-05-30

### Added

- Added support for `$removeparam`, `$queryprune`: [#41](https://github.com/ameshkov/VscodeAdblockSyntax/issues/41)
- Added support for `$stealth`: [#39](https://github.com/ameshkov/VscodeAdblockSyntax/issues/39)
- Added support for multiple DNS filtering modifiers: `$client`, `$ctag`, `$dnsrewrite`, `$dnstype`: [#38](https://github.com/ameshkov/VscodeAdblockSyntax/issues/38)
- Added support for `safari_cb_affinity` hint: [#43](https://github.com/ameshkov/VscodeAdblockSyntax/issues/43)
- Added support for `$removeparam`, `$queryprune`: [#41](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/41)
- Added support for `$stealth`: [#39](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/39)
- Added support for multiple DNS filtering modifiers: `$client`, `$ctag`, `$dnsrewrite`, `$dnstype`: [#38](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/38)
- Added support for `safari_cb_affinity` hint: [#43](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/43)

### Changed

- Added more `#if` directive special symbols

### Fixed

- Fixed an issue with empty script argument: [#42](https://github.com/ameshkov/VscodeAdblockSyntax/issues/42)
- Fixed a bug with a single `#` comment: [#37](https://github.com/ameshkov/VscodeAdblockSyntax/issues/37)
- Fixed an issue with empty script argument: [#42](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/42)
- Fixed a bug with a single `#` comment: [#37](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/37)

## [0.0.21] - 2020-10-05

Expand All @@ -89,60 +96,60 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Added

- Added ping modifier: [#33](https://github.com/ameshkov/VscodeAdblockSyntax/issues/33)
- Added extension modifier: [#31](https://github.com/ameshkov/VscodeAdblockSyntax/issues/31)
- Added more modifiers aliases: `all`, `1p`, `3p`, `css`, `frame`, `ghide`, `ehide`, `shide`, `specifichide`: [#34](https://github.com/ameshkov/VscodeAdblockSyntax/issues/34)
- Added ping modifier: [#33](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/33)
- Added extension modifier: [#31](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/31)
- Added more modifiers aliases: `all`, `1p`, `3p`, `css`, `frame`, `ghide`, `ehide`, `shide`, `specifichide`: [#34](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/34)

### Fixed

- Fixed scriptlet rules arguments: [#35](https://github.com/ameshkov/VscodeAdblockSyntax/issues/35)
- Fixed scriptlet rules arguments: [#35](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/35)

## [0.0.19] - 2019-05-26

### Added

- Added helper modifiers support: `xhr`, `first-party`, `inline-script`, `inline-font`: [#23](https://github.com/ameshkov/VscodeAdblockSyntax/issues/23)
- Added helper modifiers support: `xhr`, `first-party`, `inline-script`, `inline-font`: [#23](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/23)

### Fixed

- Fixed: handle `cookie`, `csp`, `replace` without value: [#29](https://github.com/ameshkov/VscodeAdblockSyntax/issues/29)
- Fixed: matching of content filtering rules without attribute selectors: [#28](https://github.com/ameshkov/VscodeAdblockSyntax/issues/28)
- Fixed: handle `cookie`, `csp`, `replace` without value: [#29](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/29)
- Fixed: matching of content filtering rules without attribute selectors: [#28](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/28)

## [0.0.18] - 2019-05-17

### Fixed

- Fixed: domains with `-` are marked as invalid: [#27](https://github.com/ameshkov/VscodeAdblockSyntax/issues/4227)
- Fixed: domains with `-` are marked as invalid: [#27](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/4227)

## [0.0.16] - 2019-05-16

### Changed

- Improved the `$domain` modifier performance: [#26](https://github.com/ameshkov/VscodeAdblockSyntax/issues/26)
- Improved the `$domain` modifier performance: [#26](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/26)

### Added

- Added `$redirect` modifier support: [#21](https://github.com/ameshkov/VscodeAdblockSyntax/issues/21)
- Added `$rewrite` modifier support: [#22](https://github.com/ameshkov/VscodeAdblockSyntax/issues/22)
- Added `$redirect` modifier support: [#21](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/21)
- Added `$rewrite` modifier support: [#22](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/22)

## [0.0.15] - 2019-04-06

### Added

- Added ABP snippets syntax support: [#14](https://github.com/ameshkov/VscodeAdblockSyntax/issues/14)
- Added ABP snippets syntax support: [#14](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/14)

### Fixed

- Fixed regex highlighting issue: [#18](https://github.com/ameshkov/VscodeAdblockSyntax/issues/18)
- Fixed regex highlighting issue: [#18](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/18)

## [0.0.14] - 2019-04-06

### Added

- Added $cookie modifier support: [#16](https://github.com/ameshkov/VscodeAdblockSyntax/issues/16)
- Added AdGuard scriptlet rules support: [#20](https://github.com/ameshkov/VscodeAdblockSyntax/issues/20)
- Added uBO `##^` and `##+js` syntax support: [#15](https://github.com/ameshkov/VscodeAdblockSyntax/issues/15)
- Added support for TLD domain restriction: [#19](https://github.com/ameshkov/VscodeAdblockSyntax/issues/19)
- Added $cookie modifier support: [#16](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/16)
- Added AdGuard scriptlet rules support: [#20](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/20)
- Added uBO `##^` and `##+js` syntax support: [#15](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/15)
- Added support for TLD domain restriction: [#19](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/19)

## [0.0.12] - 2018-10-18

Expand All @@ -154,29 +161,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Fixed

- Fixed an issue with CSS rules highlighting: [#13](https://github.com/ameshkov/VscodeAdblockSyntax/issues/13)
- Fixed an issue with CSS rules highlighting: [#13](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/13)

## [0.0.9] - 2018-08-30

### Added

- Added new elemhide and CSS rules markers: [#11](https://github.com/ameshkov/VscodeAdblockSyntax/issues/11)
- Added $websocket, $webrtc, $xmlhttprequest, $app: [#9](https://github.com/ameshkov/VscodeAdblockSyntax/issues/9)
- Added new elemhide and CSS rules markers: [#11](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/11)
- Added $websocket, $webrtc, $xmlhttprequest, $app: [#9](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/9)

### Fixed

- Fixed an issue with valid rules marked as invalid: [#12](https://github.com/ameshkov/VscodeAdblockSyntax/issues/12)
- Fixed an issue with valid rules marked as invalid: [#12](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/12)

## [0.0.8] - 2018-01-16

### Added

- Added $replace modifier support: [#3](https://github.com/ameshkov/VscodeAdblockSyntax/issues/3)
- Added basic regex rules hightighting: [#8](https://github.com/ameshkov/VscodeAdblockSyntax/issues/8)
- Added $replace modifier support: [#3](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/3)
- Added basic regex rules hightighting: [#8](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/8)

### Fixed

- Fixed comments highlighting: [#6](https://github.com/ameshkov/VscodeAdblockSyntax/issues/6)
- Fixed comments highlighting: [#6](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/6)

## [0.0.6] - 2018-01-15

Expand All @@ -201,8 +208,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Fixed

- Fixed domain validation rules: [#1](https://github.com/ameshkov/VscodeAdblockSyntax/issues/1)
- Fixed an issue with elemhide/css rules detection: [#1](https://github.com/ameshkov/VscodeAdblockSyntax/issues/1)
- Fixed domain validation rules: [#1](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/1)
- Fixed an issue with elemhide/css rules detection: [#1](https://github.com/AdguardTeam/VscodeAdblockSyntax/issues/1)

## [0.0.1] - 2017-12-29

Expand Down
Loading

0 comments on commit f3520b3

Please sign in to comment.