Skip to content

Commit

Permalink
Merge pull request #12 from jobara/issue-11
Browse files Browse the repository at this point in the history
GH-11: Update due to rename of default branch to main (resolves #11)
  • Loading branch information
the-t-in-rtf authored Nov 9, 2020
2 parents 5b65cef + f62618c commit b108dba
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: CI

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:
build:
Expand All @@ -14,7 +14,7 @@ jobs:

strategy:
matrix:
node-version: [12.x]
node-version: [12.x, 14.x]

env:
HEADLESS: true
Expand Down
6 changes: 3 additions & 3 deletions docs/apiComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This API requires access to `req.session`, which is provided by the `fluid.expre
That middleware requires `req.cookies`, which is provided by the `fluid.express.middleware.cookieparser` middleware.
Various endpoints accept `POST`/`PUT` data (`req.body`), so you must also have both the
`fluid.express.middleware.bodyparser.json` and `fluid.express.middleware.bodyparser.urlencoded` middleware. For details
on each of these pieces of middleware, see [the middleware documentation in `fluid.express`](https://github.com/fluid-project/fluid-express/blob/master/docs/middleware.md).
on each of these pieces of middleware, see [the middleware documentation in `fluid.express`](https://github.com/fluid-project/fluid-express/blob/main/docs/middleware.md).

The required middleware should be loaded at the same level (or higher) in the path, and before the API itself. The
order in which middleware loads is controlled using [namespaces and priorities](http://docs.fluidproject.org/infusion/development/Priorities.html).
Expand Down Expand Up @@ -76,7 +76,7 @@ outside of that path.

## Component options

In addition to the options for any instance of [`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md),
In addition to the options for any instance of [`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md),
this component supports the following unique options:

| Option | Type | Description |
Expand All @@ -96,4 +96,4 @@ content is used.
## Component Invokers

This component has no unique invokers. For details on the `route` invoker it inherits from `fluid.express.router.passthrough`,
see the [`fluid.express` router documentation](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md).
see the [`fluid.express` router documentation](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md).
12 changes: 6 additions & 6 deletions docs/currentComponent.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# `fluid.express.user.api.current`

This component provides a REST endpoint that displays information about the current user (and indicates whether they are
logged in). It is an instance of [`fluid.express.requestAware.router`]((https://github.com/fluid-project/fluid-express/blob/master/docs/requestAwareRouter.md))
logged in). It is an instance of [`fluid.express.requestAware.router`]((https://github.com/fluid-project/fluid-express/blob/main/docs/requestAwareRouter.md))
with its own `handler` (see `fluid.express.user.api.current.handler` below).

For details about making REST calls against the API endpoint provided by this component, see the [API docs](apidocs.md).

## Component options

This component supports only the common options available to any
[`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md) or
[`fluid.express.requestAware.router`](https://github.com/fluid-project/fluid-express/blob/master/docs/requestAwareRouter.md)
[`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md) or
[`fluid.express.requestAware.router`](https://github.com/fluid-project/fluid-express/blob/main/docs/requestAwareRouter.md)
instance.

## `fluid.express.user.api.current.handler`

This component is an instance of [`fluid.express.handler`]((https://github.com/fluid-project/fluid-express/blob/master/docs/handler.md)),
This component is an instance of [`fluid.express.handler`]((https://github.com/fluid-project/fluid-express/blob/main/docs/handler.md)),
meant for use with the above `requestAwareRouter`.

### Component options

In addition to the options for any instance of [`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md),
In addition to the options for any instance of [`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md),
this component supports the following unique options:

| Option | Type | Description |
Expand All @@ -33,5 +33,5 @@ this component supports the following unique options:

* Returns: Nothing.

Fulfills the standard contract for an instance of [`fluid.express.handler`]((https://github.com/fluid-project/fluid-express/blob/master/docs/handler.md)).
Fulfills the standard contract for an instance of [`fluid.express.handler`]((https://github.com/fluid-project/fluid-express/blob/main/docs/handler.md)).
It sends either information about the current user, or a message indicating that the user is not already logged in.
8 changes: 4 additions & 4 deletions docs/forgotComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This component provides a REST endpoint that can be used to request a password r
the user in an email message, which they can use to continue the process using [`/user/reset`](resetComponent.md).

This component is an instance of
[`fluid.express.router.passthrough`](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md) which
[`fluid.express.router.passthrough`](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md) which
wraps two routers. One is an instance of `fluid.express.singleTemplateRouter` that renders a "forgot password" form
using the templates defined in this package when this endpoint receives a `GET` request. The other
(`fluid.express.user.api.forgot.post`, see below) handles `POST` requests, such as AJAX requests sent using the above
Expand All @@ -15,7 +15,7 @@ For details about making REST calls against the API endpoint provided by this co
## Component options

In addition to the options for any instance of
[`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md), this component
[`fluid.express.router`](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md), this component
supports the following unique options:

| Option | Type | Description |
Expand All @@ -34,12 +34,12 @@ supports the following unique options:
## Component Invokers

This component has no unique invokers. For details on the `route` invoker it inherits from
`fluid.express.router.passthrough`, see the [`fluid.express` router documentation](https://github.com/fluid-project/fluid-express/blob/master/docs/router.md).
`fluid.express.router.passthrough`, see the [`fluid.express` router documentation](https://github.com/fluid-project/fluid-express/blob/main/docs/router.md).

## `fluid.express.user.api.forgot.post`

This component is an instance of
[`fluid.express.requestAware.router`]((https://github.com/fluid-project/fluid-express/blob/master/docs/requestAwareRouter.md))
[`fluid.express.requestAware.router`]((https://github.com/fluid-project/fluid-express/blob/main/docs/requestAwareRouter.md))
with its own `handler` (see `fluid.express.user.api.forgot.post.handler` below). It has no unique invokers or component
options.

Expand Down
4 changes: 2 additions & 2 deletions src/js/server/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
See the documentation for more details:
https://github.com/fluid-project/fluid-express-user/blob/master/docs/apiComponent.md
https://github.com/fluid-project/fluid-express-user/blob/main/docs/apiComponent.md
*/
/* eslint-env node */
Expand Down Expand Up @@ -135,7 +135,7 @@ fluid.defaults("fluid.express.user.api", {
See the documentation for details:
https://github.com/fluid-project/fluid-express-user/blob/master/docs/apiComponent.md
https://github.com/fluid-project/fluid-express-user/blob/main/docs/apiComponent.md
*/
fluid.defaults("fluid.express.user.withRequiredMiddleware", {
Expand Down
2 changes: 1 addition & 1 deletion src/js/server/forgot.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Provides the first part of a two-step password reset mechanism. See the documentation for more details:
https://github.com/fluid-project/fluid-express-user/blob/master/docs/forgotComponent.md
https://github.com/fluid-project/fluid-express-user/blob/main/docs/forgotComponent.md
*/
/* eslint-env node */
Expand Down

0 comments on commit b108dba

Please sign in to comment.