Skip to content

Commit

Permalink
Add debug to .gitignore, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cotarr committed Nov 23, 2024
1 parent 624dea7 commit 171e249
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ notes.md
*.tar
.env
sessions
debug
logs

25 changes: 22 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,29 @@ and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## Next
## Next v0.0.35

- Copy /debug/ folder to external repository "collab-auth-dev-tools"
- Delete /debug/ folder
In version v0.0.35 there are no code changes to the main collab-auth application.
The purpose of this change is to remove the debug test folder from the collab-auth repository and
create a new collab-auth-dev-tools repository to contain the relocated tests. There
are two reasons for doing this:

First, the test scripts are not compatible with the GitHub CodeQL venerability scanner.
Although test script CodeQL issues have been been designated as (Ignore, used in tests),
the number of issues causes CodeQL to fail for exceeding limits for repeating too many issues
in the public (free) GitHub CodeQL scanner.

The second reason to move the debug scripts to an external repository is to allow the
the debug tests to be further evolved and cleaned up without having to make commits
the the main collab-auth repository, when there are no actual application code changes were made.

### Changed

- Copy /debug/ folder from the collab-auth repository to the external git repository "collab-auth-dev-tools"
- Delete /debug/ folder from collab-auth repository
- Add "debug" folder to .gitignore file in collab-auth repository. This is to allow /debug/ to be a symlink to the external repository.
- Remove debug folder from package.json eslint `npm run lint` command.
- Update /docs/ to address removal of /debug/ folder to an external repository.

## [v0.0.34](https://github.com/cotarr/collab-auth/releases/tag/v0.0.34) 2024-11-20

Expand Down
8 changes: 6 additions & 2 deletions docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,11 @@
After the frustrating experience with changes to two different API testing clients,
a set of replacement tests were written for the purpose of
testing for errors following NPM dependency updates.
In the repository, the "debug/" directory contains custom a set of
These are located in an external repository "collab-auth-dev-tools".
In the repository, the "debug/" directory can be inserted
into the collab-auth repository as a symlink. The filename is listed
in the .gitignore file to hide the debug symlink from git commits.
The "debug/" directory contains custom a set of
custom scripts written in native JavaScript that use the internal NodeJs
<a href="https://nodejs.org/docs/latest-v18.x/api/globals.html">fetch</a>
library to make HTTP requests that are applied to the internal NodeJs
Expand All @@ -81,7 +85,7 @@
These tests should not be considered a comprehensive security challenge.
</p>
<ul>
<li>No automated tests included.</li>
<li>No automated tests included during installation.</li>
<li>No formal testing has been performed.</li>
</ul>
</a></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"node": ">=18"
},
"scripts": {
"lint": "npx eslint server bin/www debug SQL-tools",
"lint": "npx eslint server bin/www SQL-tools",
"start": "node ./bin/www",
"config-dev-script": "bash ./config-dev-script.sh",
"create-postgres-admin-user": "node ./SQL-tools/create-postgres-admin-user.js"
Expand Down

0 comments on commit 171e249

Please sign in to comment.