Skip to content

Commit 867697e

Browse files
committed
Prep for v1 release.
1 parent ce9acb2 commit 867697e

File tree

4 files changed

+57
-20
lines changed

4 files changed

+57
-20
lines changed

.github/workflows/release.yml

+13-18
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
# I don't see a way to reference jobs from other workflow files, so this is
2-
# mostly a copy of build.yml, with extra steps to publish the results to a release tag.
31
name: Release
42

53
on:
64
push:
75
tags:
86
- "v*"
97

10-
env:
11-
CARGO_TERM_COLOR: always
12-
138
jobs:
149
release:
1510
runs-on: ubuntu-latest
@@ -24,16 +19,16 @@ jobs:
2419
path: ./artifacts
2520

2621
- name: Create MacOS artifact
27-
working-directory: ${{ steps.download.outputs.download-path}}/FeoBlog-macos-latest
28-
run: zip -9 release.zip feoblog
22+
working-directory: ${{ steps.download.outputs.download-path}}/Diskuto-macos-latest
23+
run: zip -9 release.zip diskuto
2924

3025
- name: Create Linux artifact
31-
working-directory: ${{ steps.download.outputs.download-path}}/FeoBlog-ubuntu-latest
32-
run: zip -9 release.zip feoblog
26+
working-directory: ${{ steps.download.outputs.download-path}}/Diskuto-ubuntu-20.04
27+
run: zip -9 release.zip diskuto
3328

3429
- name: Create Windows artifact
35-
working-directory: ${{ steps.download.outputs.download-path}}/FeoBlog-windows-latest
36-
run: zip -9 release.zip feoblog.exe
30+
working-directory: ${{ steps.download.outputs.download-path}}/Diskuto-windows-latest
31+
run: zip -9 release.zip diskuto.exe
3732

3833
# github.ref gives us something like refs/tags/v1.2.3, but we just want v1.2.3
3934
- name: Get tag name
@@ -56,16 +51,16 @@ jobs:
5651
body: |
5752
See [CHANGELOG.md] for release notes.
5853
59-
[CHANGELOG.md]: https://github.com/NfNitLoop/feoblog/blob/${{ steps.tag-name.outputs.result }}/CHANGELOG.md
54+
[CHANGELOG.md]: https://github.com/diskuto/diskuto-api/blob/${{ steps.tag-name.outputs.result }}/CHANGELOG.md
6055
6156
- name: Attach MacOS Release
6257
uses: actions/upload-release-asset@v1
6358
env:
6459
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6560
with:
6661
upload_url: ${{ steps.release.outputs.upload_url }}
67-
asset_path: ${{ steps.download.outputs.download-path}}/FeoBlog-macos-latest/release.zip
68-
asset_name: feoblog-macos-${{ steps.tag-name.outputs.result }}.zip
62+
asset_path: ${{ steps.download.outputs.download-path}}/Diskuto-macos-latest/release.zip
63+
asset_name: diskuto-api-macos-${{ steps.tag-name.outputs.result }}.zip
6964
asset_content_type: application/zip
7065

7166
- name: Attach Linux (Ubuntu) Release
@@ -74,8 +69,8 @@ jobs:
7469
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7570
with:
7671
upload_url: ${{ steps.release.outputs.upload_url }}
77-
asset_path: ${{ steps.download.outputs.download-path}}/FeoBlog-ubuntu-latest/release.zip
78-
asset_name: feoblog-linux-${{ steps.tag-name.outputs.result }}.zip
72+
asset_path: ${{ steps.download.outputs.download-path}}/Diskuto-ubuntu-20.04/release.zip
73+
asset_name: diskuto-api-linux-${{ steps.tag-name.outputs.result }}.zip
7974
asset_content_type: application/zip
8075

8176
- name: Attach Windows Release
@@ -84,7 +79,7 @@ jobs:
8479
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8580
with:
8681
upload_url: ${{ steps.release.outputs.upload_url }}
87-
asset_path: ${{ steps.download.outputs.download-path}}/FeoBlog-windows-latest/release.zip
88-
asset_name: feoblog-windows-${{ steps.tag-name.outputs.result }}.zip
82+
asset_path: ${{ steps.download.outputs.download-path}}/Diskuto-windows-latest/release.zip
83+
asset_name: diskuto-api-windows-${{ steps.tag-name.outputs.result }}.zip
8984
asset_content_type: application/zip
9085

CHANGELOG.md

+42
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,48 @@
11
Changelog
22
=========
33

4+
Version 1.0.0
5+
=============
6+
7+
Date: TBD
8+
9+
* Rename to [diskuto-api].
10+
11+
* Moved to a new GitHub organization: [Diskuto]
12+
13+
* UI has been rewritten and moved into its own repository as [diskuto-web].
14+
Expect most noteworthy changes to happen in this repository moving forward, since
15+
the API changes much less often.
16+
17+
* New [full-stack] example for local testing.
18+
19+
* New OpenAPI schema for the REST API. See: [docs/rest_api/]
20+
21+
Breaking API Changes
22+
--------------------
23+
24+
* The REST API has been relocated to `/diskuto/`.
25+
This makes it much easier to serve both [diskuto-api] and [diskuto-web] from one web host.
26+
See: [nginx/default.conf] for an example.
27+
28+
Note: The old URLs are still available for backward compatibility but will soon be removed.
29+
30+
* REST API endpoints have had `/proto3` suffixes removed.
31+
These used to be there to distinguish between the HTTP and REST API URLs.
32+
33+
* Some REST API paths have been renamed to be more user-friendly.
34+
Ex: `/u/` -> `/users/`, `/i/` -> `/items/`.
35+
36+
* See [docs/rest_api/] for details.
37+
38+
39+
[diskuto-api]: https://github.com/diskuto/diskuto-api
40+
[diskuto-web]: https://github.com/diskuto/diskuto-web
41+
[Diskuto]: https://github.com/diskuto
42+
[full-stack]: ./examples/full-stack/
43+
[docs/rest_api/]: ./docs/rest_api/
44+
[nginx/default.conf]: ./examples/full-stack/nginx/default.conf
45+
446
Version 0.6.0
547
=============
648

Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "diskuto-api"
3-
version = "0.8.0-rc1"
3+
version = "1.0.0-rc1"
44
authors = ["Cody Casterline <[email protected]>"]
55
edition = "2018"
66

0 commit comments

Comments
 (0)