Skip to content

Commit

Permalink
Fix Skate release notes format (#769)
Browse files Browse the repository at this point in the history
Fixed issue with release notes by switching it to HTML from Markdown


Before:
<img width="541" alt="image"
src="https://github.com/slackhq/slack-gradle-plugin/assets/12748234/29375f1f-536d-49c7-96bb-e93a9c9b89de">


<!--
  ⬆ Put your description above this! ⬆

  Please be descriptive and detailed.
  
Please read our [Contributing
Guidelines](https://github.com/tinyspeck/slack-gradle-plugin/blob/main/.github/CONTRIBUTING.md)
and [Code of Conduct](https://slackhq.github.io/code-of-conduct).

Don't worry about deleting this, it's not visible in the PR!
-->
  • Loading branch information
linhpha authored Mar 6, 2024
1 parent e0f5213 commit c00bbda
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 11 deletions.
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ subprojects {
pluginId.set(pluginDetails.pluginId)
version.set(pluginDetails.version)
pluginDescription.set(pluginDetails.description)
changeNotes.set(file("change-notes.md").readText())
changeNotes.set(file("change-notes.html").readText())
sinceBuild.set(pluginDetails.sinceBuild)
authentication.set(
// Sip the username and token together to create an appropriate encoded auth header
Expand Down
2 changes: 1 addition & 1 deletion skate-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ We're sending analytics for almost all Skate features to track user usage. To se
3. Make call to `SkateTraceReporter` to send up the traces

## Releasing
1. Add `change-notes.md` file under `skate-plugin/` and merge it to `main`
1. Update `change-notes.html` file under `skate-plugin/` and merge it to `main`
2. Run `publish-skate` Github Action.
Behind the scene the action's running`./gradlew :skate-plugin:uploadPluginToArtifactory`
15 changes: 15 additions & 0 deletions skate-plugin/change-notes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<![CDATA[
<h2>0.7.3</h2>
<ul>
<li>
Project Generator Improvements:
<ul>
<li>Fully migrated to Skate, directly accessible via <code>File-New-Slack Subproject</code>.</li>
<li>New <code>circuit</code> option added to the UI.</li>
<li>Added option to <code>Sync</code> with Studio upon successful project generation.</li>
</ul>
</li>
<li>Code owner file parser now supports the new YAML format.</li>
<li>Begin tracking IDE indexing time via tracing.</li>
</ul>
]]>
9 changes: 0 additions & 9 deletions skate-plugin/change-notes.md

This file was deleted.

0 comments on commit c00bbda

Please sign in to comment.