Skip to content

Commit c4b7fe1

Browse files
committed
chore: merge branch 'release/1.1.0'
2 parents 0c30b37 + accea97 commit c4b7fe1

File tree

8 files changed

+68
-17
lines changed

8 files changed

+68
-17
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: JadsonLucena

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- https://github.com/angular/angular/edit/main/.github/PULL_REQUEST_TEMPLATE.md -->
2+
## PR Checklist
3+
Please check if your PR fulfills the following requirements:
4+
5+
- [ ] The commit message follows our guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
6+
- [ ] Tests for the changes have been added (for bug fixes / features)
7+
- [ ] Docs have been added / updated (for bug fixes / features)
8+
9+
10+
## PR Type
11+
What kind of change does this PR introduce?
12+
13+
<!-- Please check the one that applies to this PR using "x". -->
14+
15+
- [ ] build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
16+
- [ ] ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
17+
- [ ] chore: Update tasks that do not cause code changes
18+
- [ ] docs: Documentation only changes
19+
- [ ] feat: A new feature
20+
- [ ] fix: A bug fix
21+
- [ ] improvement: Improves a current implementation without adding a new feature or fixing a bug
22+
- [ ] perf: A code change that improves performance
23+
- [ ] refactor: A code change that neither fixes a bug nor adds a feature
24+
- [ ] revert: Reverts a previous commit
25+
- [ ] style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
26+
- [ ] test: Adding missing tests or correcting existing tests
27+
- [ ] Other... Please describe:
28+
29+
30+
## What is the current behavior?
31+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
32+
33+
Issue Number: N/A
34+
35+
36+
## What is the new behavior?
37+
38+
39+
## Does this PR introduce a breaking change?
40+
41+
- [ ] Yes
42+
- [ ] No
43+
44+
45+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
46+
47+
48+
## Other information

.github/workflows/commitlint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: Lint Commit Messages
1+
name: commitlint
22

3-
on: [pull_request]
3+
on: [push,pull_request]
44

55
jobs:
66

.github/workflows/eslint.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
name: ESLint
1+
name: eslint
22

33
on:
44
push:
55
paths:
66
- 'src/**'
7-
- 'tests/**'
7+
- 'test/**'
88
pull_request:
99
paths:
1010
- 'src/**'
11-
- 'tests/**'
11+
- 'test/**'
1212

1313
jobs:
1414

15-
test:
15+
eslint:
1616

1717
runs-on: ubuntu-latest
1818

.github/workflows/publish.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Publish Package
1+
name: publish
22

33
on:
44
release:
@@ -13,7 +13,7 @@ jobs:
1313
steps:
1414

1515
- uses: actions/checkout@main
16-
16+
1717
- uses: actions/setup-node@main
1818
with:
1919
node-version: latest
@@ -23,7 +23,7 @@ jobs:
2323
- run: npm pack --dry-run
2424
- run: npm publish
2525
env:
26-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
2727

2828
npm:
2929

@@ -32,7 +32,7 @@ jobs:
3232
steps:
3333

3434
- uses: actions/checkout@main
35-
35+
3636
- uses: actions/setup-node@main
3737
with:
3838
node-version: latest
@@ -42,4 +42,4 @@ jobs:
4242
- run: npm pack --dry-run
4343
- run: npm publish --access public
4444
env:
45-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
45+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/tests.yml renamed to .github/workflows/test.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
name: Tests
1+
name: test
22

33
on:
44
push:
55
paths:
66
- 'src/**'
7-
- 'tests/**'
87
pull_request:
98
paths:
109
- 'src/**'
11-
- 'tests/**'
1210

1311
jobs:
1412

@@ -29,4 +27,4 @@ jobs:
2927

3028
- uses: coverallsapp/github-action@master
3129
with:
32-
github-token: ${{ secrets.GITHUB_TOKEN }}
30+
github-token: ${{secrets.GITHUB_TOKEN}}

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# SignedAccess
2+
[![CodeQL](https://github.com/JadsonLucena/SignedAccess.js/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/JadsonLucena/SignedAccess.js/actions/workflows/github-code-scanning/codeql)
23
[![Test Pass](https://github.com/JadsonLucena/SignedAccess.js/workflows/Tests/badge.svg)](https://github.com/JadsonLucena/SignedAccess.js/actions?workflow=Tests)
34
[![Coverage Status](https://coveralls.io/repos/github/JadsonLucena/SignedAccess.js/badge.svg)](https://coveralls.io/github/JadsonLucena/SignedAccess.js)
45
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
@@ -202,4 +203,7 @@ verifyURL(
202203
203204
> The signURL method needs to save the information in the searchParams, so the "expires, ip, method, nonce, prefix and signature" queries are reserved for this module's control. If your original url has one of these queries previously, it will be removed or overwritten to avoid conflicts in the signature verification.
204205
205-
> The nonce is signed in the cookie or URL, but it's up to your application to save them and check if they've already been used.
206+
> The nonce is signed in the cookie or URL, but it's up to your application to save them and check if they've already been used.
207+
208+
## Specifications
209+
We strive to maintain complete code coverage in tests. With that, we provide all the necessary use cases for a good understanding of how this module works. See: [test/SignedAccess.spec.js](https://github.com/JadsonLucena/SignedAccess.js/blob/main/test/SignedAccess.spec.js)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@jadsonlucena/signedaccess",
3-
"version": "1.0.1",
3+
"version": "1.1.0",
44
"description": "Sign and verify URLs and cookies to add a layer of protection to publicly accessible routes",
55
"main": "./src/SignedAccess.js",
66
"engines": {

0 commit comments

Comments
 (0)