Merge pull request #37 from utybo/utybo/prep-release-0-0-2

Prepare 0.0.2 release
utybo · Aug 13, 2022 · 4a09b0a · 4a09b0a
2 parents b9f93c3 + 2dda8ee
commit 4a09b0a
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 10 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -151,7 +151,7 @@ jobs:
           VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
           WORKING_DIRECTORY: "website/build/output"
           PR_LABELS: "false"
-          PRODUCTION: "${{ github.event_name == 'push' }}"
+          PRODUCTION: "${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') }}"
 
   publish-snapshot:
     name: Publish snapshot

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,9 @@ 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).
 
-## [Unreleased] (0.0.2)
+## [Unreleased] (0.0.3)
+
+## [0.0.2] - 2022-08-14
 
 ### Added
 
@@ -302,5 +304,6 @@ Initial release of Tegral.
 - `tegral-web-controllers-test`
   - Initial release
 
-[Unreleased]: https://github.com/utybo/Tegral/compare/v0.0.1..main
+[Unreleased]: https://github.com/utybo/Tegral/compare/v0.0.2..main
+[0.0.2]: https://github.com/utybo/Tegral/compare/v0.0.1..v0.0.2
 [0.0.1]: https://github.com/utybo/Tegral/compare/v0.0.1
diff --git a/...-08-13-tegral-002/2022-08-13-19-26-11.png → ...-08-14-tegral-002/2022-08-13-19-26-11.png b/...-08-13-tegral-002/2022-08-13-19-26-11.png → ...-08-14-tegral-002/2022-08-13-19-26-11.png
diff --git a/docs/blog/2022-08-13-tegral-002/index.md → docs/blog/2022-08-14-tegral-002/index.md b/docs/blog/2022-08-13-tegral-002/index.md → docs/blog/2022-08-14-tegral-002/index.md
@@ -1,7 +1,7 @@
 ---
 title: Introducing Tegral 0.0.2
 description: OpenAPI support, integration testing and much more!
-slug: welcome-to-tegral-v0-0-2
+slug: introducing-tegral-0-0-2
 authors:
   - name: utybo
     title: Maintainer
@@ -10,7 +10,6 @@ authors:
 tags: [release]
 image: john-towner-p-rN-n6Miag-unsplash.jpg
 hide_table_of_contents: false
-draft: true
 ---
 
 Tegral 0.0.2 is a massive update, with over 40 bullet points in our [changelog](https://github.com/utybo/Tegral/tree/main/CHANGELOG.md)! Let's go through the biggest changes, including new OpenAPI support, integration testing support, and more robust dependency injection internals!

diff --git a/...-002/john-towner-p-rN-n6Miag-unsplash.jpg → ...-002/john-towner-p-rN-n6Miag-unsplash.jpg b/...-002/john-towner-p-rN-n6Miag-unsplash.jpg → ...-002/john-towner-p-rN-n6Miag-unsplash.jpg
diff --git a/docs/docs/modules/core/openapi/cli.md b/docs/docs/modules/core/openapi/cli.md
@@ -6,9 +6,34 @@ sidebar_position: 3
 
 The Tegral OpenAPI CLI provides an easy and convenient way of converting [OpenAPI scripts](./scripting.md) to proper OpenAPI JSON and YAML files.
 
-The CLI is not currently published. Once published, we will add additional information on how to run the CLI. For now, you can run it from source using, from the root of the Tegral repository:
+## Running the CLI
+
+You can use [JBang](https://jbang.dev) to run the CLI without installing it separately. Use the following:
 
 ```bash
-gradle :tegral-openapi:tegral-openapi-cli:installDist
-tegral-openapi/tegral-openapi-cli/build/install/tegral-openapi-cli/bin/tegral-openapi-cli
+jbang guru.zoroark.tegral:tegral-openapi-cli:VERSION --help
 ```
+
+Replace `VERSION` by the version you want.
+
+:::note
+
+If you want to run snapshot versions, you'll need an extra parameter:
+
+```bash
+jbang run --repos https://s01.oss.sonatype.org/content/repositories/snapshots/ guru.zoroark.tegral:tegral-openapi-cli:VERSION --help
+```
+
+:::
+
+## Options
+
+The following options are available:
+
+| Short flag | Long flag | Description |
+|:----------:|:---------:| ----------- |
+| `-o` | `--output` | Output file. If present, the result will be written to this file instead of being printed on the standard output. |
+| `-f` | `--formation` | Choose the format for the output, `json` (default) or `yaml` |
+| `-q` | `--quiet` | Suppress all non-error output, except for the result, i.e. suppresses log messages. |
+| `-a` | `--openapi-version` | Choose the output version for the OpenAPI file, `3.0` (default) or `3.1` |
+| `-h` | `--help` | Prints a help message |
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -165,7 +165,7 @@ const config = {
       },
       announcementBar: {
         id: 'not-released-yet',
-        content: '<strong>Welcome to Tegral!</strong> Check out the 0.0.1 <a href="/blog/welcome-to-tegral-v0-0-1">announcement</a>!',
+        content: 'Tegral version 0.0.2 <a href="/blog/introducing-tegral-0-0-2">has been released</a>!',
         backgroundColor: '#834cff',
         textColor: '#ffffff',
         isCloseable: false

diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-0.0.2-SNAPSHOT
+0.0.2