2018-08-15 22:20:59 +00:00
|
|
|
|
# Changelog
|
|
|
|
|
|
|
|
|
|
|
|
## [Unreleased]
|
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 09:59:58 +00:00
|
|
|
|
|
2019-07-11 15:09:51 +00:00
|
|
|
|
<!-- Please add new entries to the _top_ of this section. -->
|
|
|
|
|
|
|
|
|
|
|
|
## [0.3.0]
|
|
|
|
|
|
|
2019-07-11 05:30:28 +00:00
|
|
|
|
- Display Timeline Cred in the UI (#1216)
|
2019-07-10 23:56:41 +00:00
|
|
|
|
- Calculate Timeline Cred, and save it on `sourcecred load` (#1212)
|
2019-07-11 15:09:51 +00:00
|
|
|
|
- Temporarily disable the Git plugin (#1210)
|
2019-07-11 05:37:05 +00:00
|
|
|
|
- Officially support node 10 and node 12 (#1205)
|
2019-05-30 19:18:30 +00:00
|
|
|
|
- Fail quicker and with information when using invalid GH token (#1161)
|
2019-05-21 01:41:00 +00:00
|
|
|
|
- Allow the user to save or upload weight settings (#1150)
|
explorer: tweak weights on a per-node basis (#1143)
This pull request adds a weight slider to every NodeRow in the explorer,
enabling the user to manually set a weight for that node. The weights are
multiplicative with the type level weights, so that they can be changed
independently (e.g. you can have a comment that is weighted 2x higher than
regular comments, but still have comments get a low weight in general).
This pull coordinates a number of different changes across the codebase, all of
which are tested:
Adding support for manual weights in the weights and
weightsToEdgeEvaluator modules.
Modifying pagerankTable.TableRow so that it can show a slider in the second
column.
Adding piping for manual weights into the PagerankTable shared props, and
into the explorer app
Adding the slider to the NodeRow class that displays the current weight,
and can trigger the upstream weight change
Ensuring that the runPagerank call in the explorer actually uses the manual
weights
At present, there is no way to save these weights (they are ephemeral in the
frontend) and so this is clearly a prototype/tech demo level feature rather
than being ready for real usage. Correspondingly, CLI pagerank command always
uses an empty set of manual weights. I plan to remedy this in a follow-on pull
request.
Test plan: Run the included unit tests (yarn test) and also spin up the UI,
verify that it visually looks good in both Firefox and Chrome, and verify that
changing the weights and then re-running PageRank actually causes the cred of
the modified node to change.
Review plan: In addition to carefully reading the code, ensure that all of the
changes described a few paragraphs up are actually tested.
Merge plan: Squash and merge.
Thanks to @s-ben for proposing this feature in Discord, and to everyone
discussing its implications in this Discourse thread.
2019-05-18 16:20:27 +00:00
|
|
|
|
- Allow tweaking weights on a per-node basis (#1143)
|
Add `sourcecred pagerank` for backend pagerank (#1114)
This commit adds a new CLI command, `pagerank`, which runs PageRank on a
given repository. At present, the command only ever uses the default
weights, although I plan to make this configurable in the future. The
command then saves the resultant pagerank graph in the SourceCred
directory.
On its own, this command is not yet very compelling, as it doesn't
present any easily-consumed information (e.g. users' scores). However,
it is the first step for building other commands which do just that. My
intention is to make running this command the last step of `sourcecred
load`, so that future commands may assume the existence of pagerank
scores for any loaded repository.
Test plan: The new command is thoroughly tested; see
`cli/pagerank.test.js`. It also has nearly perfect code coverage (one
line missing, the dependency-injected real function for loading graphs).
Additionally, the following sequence of commands works:
```
$ yarn backend
$ node bin/sourcecred.js load sourcecred/pm
$ node bin/sourcecred.js pagerank sourcecred/pm
$ cat $SOURCECRED_DIRECTORY/data/sourcecred/pm/pagerankGraph.json
```
Material progress on #967.
2019-03-26 01:05:58 +00:00
|
|
|
|
- Add the `pagerank` command (#1114)
|
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 09:59:58 +00:00
|
|
|
|
- Add the `clear` command (#1111)
|
2019-03-07 09:49:27 +00:00
|
|
|
|
- Add description tooltips for node and edge types in the weight configuration UI (#1081)
|
2019-03-01 22:33:40 +00:00
|
|
|
|
- Add the `export-graph` command (#1110)
|
2019-02-11 21:36:14 +00:00
|
|
|
|
- Enable loading private repositories (#1085)
|
2019-02-10 20:41:00 +00:00
|
|
|
|
- Enable setting type weights to 0 in the UI (#1005)
|
2019-01-26 00:34:12 +00:00
|
|
|
|
- Add support for 🚀 and 👀 reaction types (#1068)
|
2018-11-01 23:54:41 +00:00
|
|
|
|
- Create one page per project, rather than having a selector (#988)
|
2018-10-30 22:18:19 +00:00
|
|
|
|
|
|
|
|
|
|
## [0.2.0]
|
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 09:59:58 +00:00
|
|
|
|
|
2018-10-30 02:49:11 +00:00
|
|
|
|
- Cache GitHub data, allowing for incremental and resumable loading (#622)
|
2018-09-28 03:32:43 +00:00
|
|
|
|
- Hyperlink Git commits to GitHub (#887)
|
2018-09-27 02:28:41 +00:00
|
|
|
|
- Relicense from MIT to MIT + Apache-2 (#812)
|
2018-09-21 20:24:28 +00:00
|
|
|
|
- Display short hash + summary for commits (#879)
|
2018-09-20 17:48:05 +00:00
|
|
|
|
- Hyperlink to GitHub entities (#860)
|
2018-09-17 20:44:11 +00:00
|
|
|
|
- Add GitHub reactions to the graph (#846)
|
2018-09-14 18:56:16 +00:00
|
|
|
|
- Detect references to commits (#833)
|
2018-09-13 22:46:39 +00:00
|
|
|
|
- Detect references in commit messages (#829)
|
2018-09-13 21:19:37 +00:00
|
|
|
|
- Add commit authorship to the graph (#826)
|
2018-09-13 03:30:35 +00:00
|
|
|
|
- Add `MentionsAuthor` edges to the graph (#808)
|
2018-09-07 02:06:16 +00:00
|
|
|
|
|
|
|
|
|
|
## [0.1.0]
|
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 09:59:58 +00:00
|
|
|
|
|
2018-09-05 18:57:20 +00:00
|
|
|
|
- Organize weight config by plugin (#773)
|
Configure forward/backward edge weights separately (#749)
This commit introduces a new component, `EdgeTypeConfig`, which is
responsible for configuring the weights for a given edge type. The
config creates two `WeightSlider`s: one for the forward direction, and
one for the backward direction. The `DirectionalitySlider` is no longer
used, and is removed. This fixes #596.
So as to avoid confusion, we now describe every edge with variables, as
in 'α REFERENCES β', and clarify that the weight modifies how cred flows
from β to α. This necessitated the creation of an `EdgeWeightSlider`,
local to the `EdgeTypeConfig`, which sets up a `WeightSlider` with the
necessary greek characters.
The EdgeTypeConfig is tested, so this is continuing progress towards
solving #604.
Test plan: I manually verified that modifying edge weights has the
expected effect on cred scores. Also, some new unit tests are included.
2018-09-04 22:37:00 +00:00
|
|
|
|
- Configure edge forward/backward weights separately (#749)
|
2018-09-03 21:34:14 +00:00
|
|
|
|
- Combine "load graph" and "run pagerank" into one button (#759)
|
2018-09-01 17:42:30 +00:00
|
|
|
|
- Store GitHub data compressed at rest, reducing space usage by 6–8× (#750)
|
2018-08-31 02:21:59 +00:00
|
|
|
|
- Improve weight sliders display (#736)
|
2018-08-29 22:14:42 +00:00
|
|
|
|
- Separate bots from users in the UI (#720)
|
2018-08-29 22:06:12 +00:00
|
|
|
|
- Add a feedback link to the prototype (#715)
|
2018-08-29 21:52:26 +00:00
|
|
|
|
- Support combining multiple repositories into a single graph (#711)
|
2018-08-29 19:20:57 +00:00
|
|
|
|
- Normalize scores so that 1000 cred is split amongst users (#709)
|
Stop persisting users' weight choices (#706)
Storing the user's weights in localStore enables a workflow where a
user chooses their preferred weights, and brings those weights with them
across projects and contexts. However, this is the wrong workflow:
actually, a project chooses its weights, and when a user visits a
particular project, they want to sync up with the project's choice.
Giving the user the ability to modify the weights and recalculate is
still important, so that they can propose improvements to the project
maintainer. But implicitly keeping their modified weights, and even
bringing them to other projects the user inspects, is
counter-productive.
This commit removes this dubious feature. (It's a feature we were likely
to drop anyway, as it conflicts with #703.) As an added bonus, this code
is untested, which means the feature is technical debt—so removing it
reduces our technical debt! It also removes at least one known bug.
Test plan: There are no tests. I manually verified that the frontend
still works, and that it no longer persists weights across refresh.
2018-08-29 18:46:48 +00:00
|
|
|
|
- Stop persisting weights in local store (#706)
|
2018-08-22 18:37:29 +00:00
|
|
|
|
- Execute GraphQL queries with exponential backoff (#699)
|
Re-introduce a simplified git plugin (#685)
This commit re-introduces the git plugin, now that it has been radically
simplified as described in [1]. The new git plugin only has nodes for
commits and only has commit has-parent edges. As compared to the version
that was removed in #628, this plugin is far leaner. It doesn't bloat
the graph (for `sourcecred/sourcecred`, the git plugin data is just
164k), and as such doesn't incur much performance penalty.
Re-incorporating the git plugin also brings some tangible benefits. We
already had git nodes in the graph, as the GitHub plugin attaches them
to pull requests. Without any git plugin, these nodes are displayed as
"uknown nodes" with ugly descriptions. Also, including a git plugin,
even one that is very minimal, communicates to users that git is a
source of information to SourceCred, and that they can expect more from
it in the future.
Note that this commit breaks backcompat for existing repositories that
were locally loaded after #628. As such, it is best to
`rm -rf $SOURCECRED_DIRECTORY` and start with fresh data. Also, due to a
known bug in the WeightConfig, you should reset your browser's local
storage.
Test plan: After removing the SourceCred directory and the stale
localStorage, the cred explorer nicely displays git commits, and
connects them via has_parent edges. The NodeType filter allows filtering
to commits as expected, and the WeightConfig shows node and edge weights
for the Git plugin's nodes and edges.
[1]: https://github.com/sourcecred/sourcecred/issues/627#issuecomment-413435447
2018-08-16 20:20:41 +00:00
|
|
|
|
- Introduce a simplified Git plugin that only tracks commits (#685)
|
2018-08-16 05:22:21 +00:00
|
|
|
|
- Rename cred explorer table columns (#680)
|
2018-08-16 18:14:52 +00:00
|
|
|
|
- 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`
|
