Skip to content

Commit

Permalink
feat-fix: update doc link
Browse files Browse the repository at this point in the history
  • Loading branch information
EagleoutIce committed Jul 12, 2024
1 parent 17d12ae commit c98bffa
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/broken-links-and-wiki.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
- name: Check the README for broken links
uses: becheran/mlc@v0.17.0
with:
args: --do-not-warn-for-redirect-to "http*://github.com/flowr-analysis/*,http*://code-inspect.github.io/*" --ignore-links "http*://hub.docker.com/r/*" README.md
args: --do-not-warn-for-redirect-to "http*://github.com/flowr-analysis/*,http*://flowr-analysis.github.io/*" --ignore-links "http*://hub.docker.com/r/*" README.md

- name: Publish the Wiki
uses: Andrew-Chen-Wang/github-wiki-action@v4
Expand All @@ -80,4 +80,4 @@ jobs:
uses: becheran/mlc@v0.17.0
if: ${{ always() && !failure() }}
with:
args: --do-not-warn-for-redirect-to "http*://github.com/flowr-analysis/*,http*://code-inspect.github.io/*" wiki/
args: --do-not-warn-for-redirect-to "http*://github.com/flowr-analysis/*,http*://flowr-analysis.github.io/*" wiki/
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ To get started with _flowR_, please check out the [Overview](https://github.com/
docker run -it --rm eagleoutice/flowr
```


## 📜 More Information

For more details, see the [wiki pages](https://github.com/flowr-analysis/flowr/wiki) and the deployed [code documentation](https://code-inspect.github.io/flowr/doc/).
For more details, see the [wiki pages](https://github.com/flowr-analysis/flowr/wiki) and the deployed [code documentation](https://flowr-analysis.github.io/flowr/doc/).

## 🚀 Contributing

Expand Down
2 changes: 1 addition & 1 deletion test/performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

All of these benchmarks are meant to be executed on a linux machine, preferably the continuous integration environment. Hence, all scripts are written in bash and allowed to use tools to symlink etc.

Currently, tests are not repeated, so all results are subject to the variations in the CI environment. For the results, see: <https://code-inspect.github.io/flowr/wiki/stats/benchmark>.
Currently, tests are not repeated, so all results are subject to the variations in the CI environment. For the results, see: <https://flowr-analysis.github.io/flowr/wiki/stats/benchmark>.

## How to Run?

Expand Down
2 changes: 1 addition & 1 deletion wiki/Core.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***This wiki page is currently under construction***

This wiki page should give the in-depth explanation of the inner workings of *flowR*. To avoid duplication it may often contain links to the internal code documentation (located here: <https://code-inspect.github.io/flowr/doc/>).
This wiki page should give the in-depth explanation of the inner workings of *flowR*. To avoid duplication it may often contain links to the internal code documentation (located here: <https://flowr-analysis.github.io/flowr/doc/>).

<!-- TOC -->
- [The Slicing Process](#the-slicing-process)
Expand Down
2 changes: 1 addition & 1 deletion wiki/Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -2909,4 +2909,4 @@ We use `example.name` to avoid duplication with the name that we have assigned t
`'comments'` refers to a freely chosen (but unique) name, that will be used as the name for the output file within the folder. The `comments` variable holds the result of the query, which is an array of nodes. Finally, we pass the `filepath` of the file that was analyzed (if known), so that it can be added to the statistics file (as additional information).

-----
<a id="note1" href="#note1ref">&lt;1&gt;</a>: For more information, see the code documentation at: <https://code-inspect.github.io/flowr/doc/>.
<a id="note1" href="#note1ref">&lt;1&gt;</a>: For more information, see the code documentation at: <https://flowr-analysis.github.io/flowr/doc/>.
9 changes: 5 additions & 4 deletions wiki/Linting and Testing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
For the latest code-coverage information, see [codecov.io](https://app.codecov.io/gh/flowr-analysis/flowr), for the latest benchmark results, see the [benchmark results](https://code-inspect.github.io/flowr/wiki/stats/benchmark) wiki page.
For the latest code-coverage information, see [codecov.io](https://app.codecov.io/gh/flowr-analysis/flowr), for the latest benchmark results, see the [benchmark results](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark) wiki page.

- [Testing Suites](#testing-suites)
- [Functionality Tests](#functionality-tests)
Expand Down Expand Up @@ -72,9 +72,10 @@ To run them, issue:
npm run performance-test
```

See [test/performance](https://github.com/flowr-analysis/flowr/tree/main/test/performance) for more information on the suites, how to run them, and their results. If you are interested in the results of the benchmarks, see [here](https://code-inspect.github.io/flowr/wiki/stats/benchmark).
See [test/performance](https://github.com/flowr-analysis/flowr/tree/main/test/performance) for more information on the suites, how to run them, and their results. If you are interested in the results of the benchmarks, see [here](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark).

### Oh no, the tests are slow

If the tests are too slow for your taste, you may want to check out how to [run only some of the tests](#running-only-some-tests).

### Testing Within Your IDE
Expand Down Expand Up @@ -120,11 +121,11 @@ We explain the most important workflows in the following:
- [run.yaml](../.github/workflows/run.yaml) is a [reusable workflow](https://docs.github.com/en/actions/using-workflows/reusing-workflows) that we use *whenever* we want to run a *flowR* npm script in the pipeline (furthermore, this hides necessary extra steps for coverage, documentation, and benchmarks).
- [qa.yaml](../.github/workflows/qa.yaml) is the main workflow which will run different steps depending on several factors. It is responsible for:
- running the [functionality](#functionality-tests) and [performance tests](#performance-tests)
- uploading the results to the [benchmark page](https://code-inspect.github.io/flowr/wiki/stats/benchmark) for releases
- uploading the results to the [benchmark page](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark) for releases
- running the [functionality tests](#functionality-tests) on different operating systems (Windows, macOS, Linux) and with different versions of R
- reporting code coverage
- running the [linter](#linting) and reporting its results
- deploying the documentation to [GitHub Pages](https://code-inspect.github.io/flowr/doc/)
- deploying the documentation to [GitHub Pages](https://flowr-analysis.github.io/flowr/doc/)
- [release.yaml](../.github/workflows/release.yaml) is responsible for creating a new release, only to be run by repository owners. Furthermore, it adds the new docker image to [docker hub](https://hub.docker.com/r/eagleoutice/flowr).
- [broken-links-and-wiki.yaml](../.github/workflows/broken-links-and-wiki.yaml) repeatedly tests that all links are not dead!

Expand Down

2 comments on commit c98bffa

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"artificial" Benchmark Suite

Benchmark suite Current: c98bffa Previous: d16b9a2 Ratio
Retrieve AST from R code 247.72291736363638 ms (108.40507868922549) 241.68802936363636 ms (102.8761180575731) 1.02
Normalize R AST 32.48963481818182 ms (63.90196860476745) 31.739752136363638 ms (62.50756200538419) 1.02
Produce dataflow information 56.974053363636365 ms (139.2925673420337) 53.60407036363637 ms (129.65284550123417) 1.06
Total per-file 1356.5997095 ms (3377.768612915593) 1269.491520090909 ms (3081.8881842692626) 1.07
Static slicing 1.2105048846396174 ms (1.0349203879888993) 1.1992957765588008 ms (1.0956190505793448) 1.01
Reconstruct code 0.4338827926872065 ms (0.26335672395218884) 0.40823540912587025 ms (0.23279531342826934) 1.06
Total per-slice 1.6632384478527709 ms (1.1175640488911152) 1.6255373838885934 ms (1.1638162453002103) 1.02
failed to reconstruct/re-parse 0 # 0 # 1
times hit threshold 0 # 0 # 1
reduction (characters) 0.7974469447714406 # 0.7974469447714406 # 1
reduction (normalized tokens) 0.774073695901592 # 0.774073695901592 # 1
memory (df-graph) 147.58589311079547 KiB (359.2574768951678) 147.58589311079547 KiB (359.2574768951678) 1

This comment was automatically generated by workflow using github-action-benchmark.

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"social-science" Benchmark Suite

Benchmark suite Current: c98bffa Previous: d16b9a2 Ratio
Retrieve AST from R code 246.72872036 ms (45.29393712283888) 247.62148213999998 ms (45.06237178263203) 1.00
Normalize R AST 32.63685102 ms (27.073139241680586) 31.95647656 ms (25.60791349140293) 1.02
Produce dataflow information 82.34045938 ms (93.24992357550241) 81.06377198 ms (92.78105042956382) 1.02
Total per-file 2236.8622809000003 ms (3788.215271049408) 2253.7859776799996 ms (3816.1054094291667) 0.99
Static slicing 4.317846910091668 ms (7.952067379037062) 4.320062977207287 ms (7.979427803781336) 1.00
Reconstruct code 0.39244438165081474 ms (0.20978787134019497) 0.4180827296166881 ms (0.21129610863943676) 0.94
Total per-slice 4.719372359296022 ms (8.04052824983175) 4.7471979325717735 ms (8.060206129507852) 0.99
failed to reconstruct/re-parse 0 # 0 # 1
times hit threshold 0 # 0 # 1
reduction (characters) 0.9250085598882571 # 0.9250085598882571 # 1
reduction (normalized tokens) 0.8936602769604 # 0.8936602769604 # 1
memory (df-graph) 142.5463671875 KiB (146.6995040110581) 142.5463671875 KiB (146.6995040110581) 1

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.