status-im/sourcecred
2
0
Fork 0
mirror of https://github.com/status-im/sourcecred.git synced 2025-01-10 20:56:29 +00:00
Code Issues Projects Releases Wiki Activity
sourcecred/CHANGELOG.md
Brian Litwin 0f038305a2 Add CLI command to clear sourcecred data directory (#1111) 
Resolves #1067

Adds the CLI commands:
`sourcecred clear --all` -- removes the $SOURCECRED_DIRECTORY
`sourcecred clear --cache` -- removes the cache directory
`sourcecred clear --help` -- provides usage info
`sourcecred clear` -- prompts the user to be more specific

Test plan:
The unit tests ensure that the command is properly wired into the
 sourcecred CLI, including help text integration. However, just to be
safe, we can start by verifying that calling `sourcecred` without
arguments lists the `clear` command as a valid option, and that
calling `sourcecred help clear` prints help information. (Note: it's
necessary to run `yarn backend` before testing these changes)

The unit tests also ensure that the command removes the proper
directories, so there isn't really a need to manually test it,
although the reviewer may choose to do so to be safe.

Although out of scope for unit tests on this function, we can also do
integration tests, to make sure that running the clear command doesn't
leave the sourcecred directory in an invalid state from the perspective of the `load` command.

```js
$ yarn backend;
$ node bin/sourcecred.js load sourcecred/example-github;
$ node bin/sourcecred.js clear --cache;
$ node bin/sourcecred.js load sourcecred/example-github;
$ node bin/sourcecred.js clear --all;
$ node bin/sourcecred.js load sourcecred/example-github;
```
The expected behavior of the above command block is that the load command never fails or throws an error.

@decentralion and I discussed the scenario where `rimraf` errors.
We decided that testing this scenario wasn't necessary, because
`rimraf` doesn't error if a directory doesn't exist, and
rimraf's maintainer suggests [monkey-patching the fs module]
to get rimraf to error in testing scenarios.

Thanks @decentralion for reviewing and pair-programming this with me.

[monkey-patching the fs module]: https://github.com/isaacs/rimraf/issues/31#issuecomment-29534796
2019-05-13 12:59:58 +03:00

1.9 KiB
Raw Blame History

Changelog

[Unreleased]

  • Add the pagerank command (#1114)
  • Add the clear command (#1111)
  • Add description tooltips for node and edge types in the weight configuration UI (#1081)
  • Add the export-graph command (#1110)
  • Enable loading private repositories (#1085)
  • Enable setting type weights to 0 in the UI (#1005)
  • Add support for 🚀 and 👀 reaction types (#1068)
  • Create one page per project, rather than having a selector (#988)

[0.2.0]

  • Cache GitHub data, allowing for incremental and resumable loading (#622)
  • Hyperlink Git commits to GitHub (#887)
  • Relicense from MIT to MIT + Apache-2 (#812)
  • Display short hash + summary for commits (#879)
  • Hyperlink to GitHub entities (#860)
  • Add GitHub reactions to the graph (#846)
  • Detect references to commits (#833)
  • Detect references in commit messages (#829)
  • Add commit authorship to the graph (#826)
  • Add MentionsAuthor edges to the graph (#808)

[0.1.0]

  • Organize weight config by plugin (#773)
  • Configure edge forward/backward weights separately (#749)
  • Combine "load graph" and "run pagerank" into one button (#759)
  • Store GitHub data compressed at rest, reducing space usage by 6–8× (#750)
  • Improve weight sliders display (#736)
  • Separate bots from users in the UI (#720)
  • Add a feedback link to the prototype (#715)
  • Support combining multiple repositories into a single graph (#711)
  • Normalize scores so that 1000 cred is split amongst users (#709)
  • Stop persisting weights in local store (#706)
  • Execute GraphQL queries with exponential backoff (#699)
  • Introduce a simplified Git plugin that only tracks commits (#685)
  • Rename cred explorer table columns (#680)
  • Display version string in the app's footer
  • Support hosting SourceCred instances at arbitrary gateways, not just the root of a domain (#643)
  • Aggregate over connection types in the cred explorer (#502)
  • Start tracking changes in CHANGELOG.md