0.9.0 Release Prep

.github/workflows/deployment.yml

@@ -9,17 +9,14 @@ jobs:
   deploy_docs:
     runs-on: ubuntu-latest
     container:
-      image: crystallang/crystal:latest-alpine
+      image: crystallang/crystal
     steps:
       - uses: actions/checkout@v2
-      - name: Install Dependencies
-        run: shards install --production
       - name: Build
-        run: make docs
+        run: crystal docs
       - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@3.5.2
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: JamesIves/github-pages-deploy-action@2.0.1
+        env:
+          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
           BRANCH: gh-pages
           FOLDER: docs
-          SINGLE_COMMIT: true

README.md

@@ -5,18 +5,6 @@
 
 A web framework comprised of reusable, independent components.
 
-## Installation
-
-1. Add the dependency to your `shard.yml`:
-
-```yaml
-dependencies:
-  athena:
-    github: athena-framework/athena
-```
-
-2. Run `shards install`
-
 ## Documentation
 
 Everything is documented in the [API Docs](https://athena-framework.github.io/athena/Athena/Routing.html).

shard.yml

@@ -1,6 +1,6 @@
 name: athena
 
-version: 0.8.0
+version: 0.9.0
 
 crystal: 0.35.0
 
@@ -25,7 +25,7 @@ dependencies:
     version: ~> 0.1.0
   athena-dependency_injection:
     github: athena-framework/dependency-injection
-    branch: di-refactor-v2
+    version: ~> 0.2.0
   amber_router:
     github: amberframework/amber-router
     version: ~> 0.4.1

spec/redirect_response_spec.cr

@@ -7,7 +7,7 @@ describe ART::RedirectResponse do
     end
 
     it "disallows non redirect codes" do
-      expect_raises(ArgumentError, "422 is not an HTTP redirect status code.") do
+      expect_raises(ArgumentError, "'422' is not an HTTP redirect status code.") do
         ART::RedirectResponse.new("addresss", 422)
       end
     end

src/annotations.cr

@@ -1,5 +1,5 @@
 module Athena::Routing
-  # Defines a GET endpoint.
+  # Defines a `GET` endpoint.
   #
   # A corresponding `HEAD` endpoint is also defined.
   #
@@ -15,7 +15,7 @@ module Athena::Routing
   # ```
   annotation Get; end
 
-  # Defines a POST endpoint.
+  # Defines a `POST` endpoint.
   #
   # ## Fields
   # * path : `String` - The path for the endpoint, may also be provided as the first positional argument.
@@ -29,7 +29,7 @@ module Athena::Routing
   # ```
   annotation Post; end
 
-  # Defines a PUT endpoint.
+  # Defines a `PUT` endpoint.
   #
   # ## Fields
   # * path : `String` - The path for the endpoint, may also be provided as the first positional argument.
@@ -43,7 +43,7 @@ module Athena::Routing
   # ```
   annotation Put; end
 
-  # Defines a PATCH endpoint.
+  # Defines a `PATCH` endpoint.
   #
   # ## Fields
   # * path : `String` - The path for the endpoint, may also be provided as the first positional argument.
@@ -57,7 +57,7 @@ module Athena::Routing
   # ```
   annotation Patch; end
 
-  # Defines a DELETE endpoint.
+  # Defines a `DELETE` endpoint.
   #
   # ## Fields
   # * path : `String` - The path for the endpoint, may also be provided as the first positional argument.
@@ -71,7 +71,7 @@ module Athena::Routing
   # ```
   annotation Delete; end
 
-  # Applies an `ART::ParamConverterInterface` to a given parameter.
+  # Applies an `ART::ParamConverterInterface` to a given argument.
   #
   # See `ART::ParamConverterInterface` for more information on defining a param converter.
   #
@@ -91,7 +91,7 @@ module Athena::Routing
   # ```
   annotation ParamConverter; end
 
-  # Defines a `ART::Parameters::QueryParameter` tied to a given route.
+  # Defines a query parameter tied to a given argument.
   #
   # The type of the query param is derived from the type restriction of the associated controller action argument.
   #
@@ -107,8 +107,8 @@ module Athena::Routing
   #
   # ```
   # @[ART::Get(path: "/example")]
-  # @[ART::QueryParam(name: "value")]
-  # def get_user(name : String) : Nil
+  # @[ART::QueryParam("query_param")]
+  # def get_user(query_param : String) : Nil
   # end
   # ```
   annotation QueryParam; end