Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

πŸ“šπŸš§βœ¨ Make changelog linkable (use explicit anchors) #1090

Merged
merged 1 commit into from
Jun 6, 2022

Conversation

s-weigand
Copy link
Member

@s-weigand s-weigand commented Jun 6, 2022

This makes the links explicitly named (permanent) instead of iterating over an index which lead to moving links
Ref.: https://myst-parser.readthedocs.io/en/latest/intro.html#cross-referencing

Change summary

Checklist

  • βœ”οΈ Passing the tests (mandatory for all PR's)
  • 🚧 Added changes to changelog (mandatory for all PR's)

@github-actions
Copy link
Contributor

github-actions bot commented Jun 6, 2022

Binder πŸ‘ˆ Launch a binder notebook on branch s-weigand/pyglotaran/proper-links-to-changelog

@s-weigand s-weigand changed the title πŸ“šπŸš§βœ¨ Added cross-references to changelog version sections πŸ“šπŸš§βœ¨ Make changelog linkable (use explicit anchors) Jun 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jun 6, 2022

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.5.1 vs. main

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [96b42630]       [dd542b28]
     <v0.5.1>                   
       51.1Β±0.2ms       50.9Β±0.1ms     1.00  BenchmarkOptimize.time_optimize(False, False, False)
       54.6Β±0.6ms       54.6Β±0.5ms     1.00  BenchmarkOptimize.time_optimize(False, False, True)
       51.3Β±0.3ms       50.9Β±0.2ms     0.99  BenchmarkOptimize.time_optimize(False, True, False)
       55.5Β±0.9ms       54.9Β±0.7ms     0.99  BenchmarkOptimize.time_optimize(False, True, True)
       61.9Β±0.1ms       62.0Β±0.3ms     1.00  BenchmarkOptimize.time_optimize(True, False, False)
         72.3Β±6ms        71.2Β±20ms     0.98  BenchmarkOptimize.time_optimize(True, False, True)
       62.2Β±0.2ms       62.0Β±0.5ms     1.00  BenchmarkOptimize.time_optimize(True, True, False)
       71.6Β±0.9ms       71.0Β±0.7ms     0.99  BenchmarkOptimize.time_optimize(True, True, True)
             201M             205M     1.02  IntegrationTwoDatasets.peakmem_optimize
       1.89Β±0.01s       1.84Β±0.02s     0.97  IntegrationTwoDatasets.time_optimize

Benchmark diff main vs. PR

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [022499a4]       [dd542b28]
       51.2Β±0.2ms       50.9Β±0.1ms     0.99  BenchmarkOptimize.time_optimize(False, False, False)
       54.7Β±0.8ms       54.6Β±0.5ms     1.00  BenchmarkOptimize.time_optimize(False, False, True)
       51.3Β±0.2ms       50.9Β±0.2ms     0.99  BenchmarkOptimize.time_optimize(False, True, False)
       54.8Β±0.7ms       54.9Β±0.7ms     1.00  BenchmarkOptimize.time_optimize(False, True, True)
       62.0Β±0.2ms       62.0Β±0.3ms     1.00  BenchmarkOptimize.time_optimize(True, False, False)
       71.5Β±0.2ms        71.2Β±20ms     1.00  BenchmarkOptimize.time_optimize(True, False, True)
       62.3Β±0.2ms       62.0Β±0.5ms     0.99  BenchmarkOptimize.time_optimize(True, True, False)
       71.2Β±0.9ms       71.0Β±0.7ms     1.00  BenchmarkOptimize.time_optimize(True, True, True)
             205M             205M     1.00  IntegrationTwoDatasets.peakmem_optimize
       1.82Β±0.02s       1.84Β±0.02s     1.01  IntegrationTwoDatasets.time_optimize

@codecov
Copy link

codecov bot commented Jun 6, 2022

Codecov Report

Merging #1090 (022499a) into main (022499a) will not change coverage.
The diff coverage is n/a.

❗ Current head 022499a differs from pull request most recent head dd542b2. Consider uploading reports for the commit dd542b2 to get more accurate results

@@          Coverage Diff          @@
##            main   #1090   +/-   ##
=====================================
  Coverage   87.1%   87.1%           
=====================================
  Files        101     101           
  Lines       5339    5339           
  Branches     995     995           
=====================================
  Hits        4654    4654           
  Misses       530     530           
  Partials     155     155           

Continue to review full report at Codecov.

Legend - Click here to learn more
Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data
Powered by Codecov. Last update 022499a...dd542b2. Read the comment docs.

jsnel
jsnel previously approved these changes Jun 6, 2022
@s-weigand s-weigand force-pushed the proper-links-to-changelog branch from e0f203b to dd542b2 Compare June 6, 2022 21:09
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 6, 2022

Kudos, SonarCloud Quality Gate passed!Β  Β  Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.7% 0.7% Duplication

@jsnel jsnel merged commit 6c3c390 into glotaran:main Jun 6, 2022
@s-weigand s-weigand deleted the proper-links-to-changelog branch June 11, 2022 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants