Skip to content

Commit

Permalink
Prepare for releasing v3.3.2
Browse files Browse the repository at this point in the history
Also update various parts of the documentation.
  • Loading branch information
FWDekker committed Sep 28, 2024
1 parent dc8bc54 commit 694133b
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 20 deletions.
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ assignees: FWDekker
<!-- If applicable, add screenshots to help explain your problem. -->

**Version information**
- Randomness version [e.g. 3.3.1]: <!-- Check `Settings -> Plugins` in your IDE and search for `Randomness` -->
- IDE version [e.g. IntelliJ Community 2023.3.3]: <!-- Check `Help -> About` in your IDE -->
- Operating system [e.g. Windows 11, Ubuntu 22.04.3, macOS 14.2.1]: <!-- Use a search engine for help if you don't know -->
- Java version [e.g. 17.0.9, 21.0.1]: <!-- Run `java -version` in a terminal or check https://www.java.com/en/download/help/version_manual.xml -->
- Randomness version [e.g. 3.3.2]: <!-- Check `Settings -> Plugins` in your IDE and search for `Randomness` -->
- IDE version [e.g. IntelliJ Community 2024.2.3]: <!-- Check `Help -> About` in your IDE -->
- Operating system [e.g. Windows 11, Ubuntu 24.04.1, macOS 15.0]: <!-- Use a search engine for help if you don't know -->

**Additional context**
<!-- Add any other context about the problem here. -->
4 changes: 3 additions & 1 deletion .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
2. "Optimize Transparency" with 2% fuzz
3. "Lossy GIF" with compression level 30
* Ensure documentation generates without errors.
After the release, run the `cd.yml` workflow to update the `gh-pages` branch.
After the release, the [`cd.yml` workflow](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml)
should automatically update the `gh-pages` branch.
Check that the build action does not fail!

## Verification
* Run tests and static analysis one more time.
Expand Down
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ supported and supplied with security patches.

## Reporting a vulnerability
To report a vulnerability in Randomness, please use
[GitHub's vulnerability reporting feature](https://github.com/FWDekker/mommy/security/advisories/new).
[GitHub's vulnerability reporting feature](https://github.com/FWDekker/intellij-randomness/security/advisories/new).
You will be contacted as soon as possible.
You will be thanked publicly for reporting the vulnerability, unless you indicate that you prefer to be thanked
anonymously.
8 changes: 5 additions & 3 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ jobs:
with:
ref: gh-pages
path: gh-pages
# Required to push updated documentation to repository
# Required to push updated documentation to repository.
# If you get "Error: fatal: could not read Username for 'https://github.com': terminal prompts disabled", then
# the token has probably expired.
token: ${{ secrets.personal_access_token }}

- name: Set up Java
Expand All @@ -29,9 +31,9 @@ jobs:
distribution: 'temurin'
java-version: '17'
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v3
uses: gradle/actions/setup-gradle@v4
working-directory: main/
with:
build-root-directory: main/
add-job-summary: on-failure

- name: Extract version number
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ name: CI
on:
push:
paths-ignore:
- 'CHANGELOG.md'
- 'README.md'
- '.github/**.md'
- '.github/img/**'
pull_request:
paths-ignore:
- 'CHANGELOG.md'
- 'README.md'
- '.github/**.md'
- '.github/img/**'
Expand Down Expand Up @@ -46,7 +48,7 @@ jobs:
distribution: 'temurin'
java-version: '17'
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v3
uses: gradle/actions/setup-gradle@v4
with:
add-job-summary: on-failure
- name: Run tests
Expand All @@ -63,7 +65,7 @@ jobs:
distribution: 'temurin'
java-version: '17'
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v3
uses: gradle/actions/setup-gradle@v4
with:
add-job-summary: on-failure
- name: Run tests
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Changelog
## [9.9.9-unreleased]
## 3.3.2 -- 2024-09-28
### Added
* Added even more debug info for future reports relating to issue [#R1](https://github.com/FWDekkerBot/intellij-randomness-issues/issues/1).

### Changed
* Changed icon instantiation to be more in line with guidelines, hopefully fixing [#R13](https://github.com/FWDekkerBot/intellij-randomness-issues/issues/13).
* Updated various dependencies, especially those related to tooling.


## 3.3.1 -- 2024-05-06
Expand Down
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ $ gradlew buildPlugin # Build an installable zip of the plugin
$ gradlew buildPlugin -Pbuild.hotswap # Same as above, but allow hot-swapping the plugin during development
$ gradlew signPlugin # Sign built plugin
```

Signing the plugin requires specific environment variables to be set to refer to appropriate key files.
See [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html) for more information.

Expand All @@ -109,23 +110,35 @@ $ gradlew runPluginVerifier # Check for compatibility issues

#### 🏷️ Tagging and filtering tests
[Kotest tests can be tagged](https://kotest.io/docs/framework/tags.html) to allow selectively running tests.
Simply run Gradle with argument `-Pkotest.tags="X"` to run only tests tagged with tag `X`.
The tags for Randomness are statically defined in
[`Tags`](https://github.com/FWDekker/intellij-randomness/blob/main/src/test/kotlin/com/fwdekker/randomness/testhelpers/Tags.kt).
If you want to debug a test, you can tag it with the `Focus` tag to ensure only those tests run.
Alternatively, prefix the description with the string `f:`.
Make sure you remove the tag afterwards!

Tag an entire test class by adding `tags(...)` to the class definition, or tag an individual test `context` by
You can tag an entire test class by adding `tags(...)` to the class definition, or tag an individual test `context` by
writing `context("foo").config(tags = setOf(...)) {`.
It is not possible to tag an individual `test` due to limitations in Kotest.

To run only one `context` in some test class `X`, prefix the `context`'s name with `f:` and run with `--tests X`.
The prefix `f:` filters out other `context`s in that test class, and `--tests X` filters out other test classes.
Alternatively, tag the desired `context` with the `Focus` tag and run with `-Pkotest.tags="Focus"` to filter by that
tag.
Due to limitations in Kotest, you can only tag the outer level of `context`s;
you cannot tag a nested `context` or an individual `test`.
This is also true for prefixing with `f:`.

### 📚 Documentation
```bash
$ gradlew dokkaHtml # Generate documentation
$ gradlew dokkaHtml # Generate documentation
$ gradlew dokkaHtml -Pdokka.pagesDir=/foo # Generate linked documentation
```

Whenever a release is created on GitHub, [GitHub Actions generates new
documentation](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml), after which this is deployed
to [GitHub Pages](https://fwdekker.github.io/intellij-randomness/).

Documentation pages link to each other using a version dropdown menu.
Simply running `gradlew dokkaHtml` does not generate a dropdown menu, because Dokka is not automatically aware of all
previous versions.
To link the versions together, check out the `gh-branch` of this repository in a separate directory, and point
`dokka.pagesDir` to that directory.

### 🖼 Icons
The icons used by the plugin are found in [the file `icons.sketch`](.github/img/icons.sketch).
You can open this file with [Sketch](https://www.sketch.com/) (macOS), [Lunacy](https://icons8.com/lunacy) (Windows), or
Expand Down

0 comments on commit 694133b

Please sign in to comment.