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

docs: guide for creating new releases #1304

Merged
merged 9 commits into from Feb 8, 2023
Merged

docs: guide for creating new releases #1304

merged 9 commits into from Feb 8, 2023

Conversation

wodeni
Copy link
Member

@wodeni wodeni commented Feb 6, 2023

Description

This PR adds a guide to creating new releases, mostly following and expanding the description in #1290.

@wodeni wodeni requested a review from samestep February 6, 2023 15:59
@github-actions
Copy link

github-actions bot commented Feb 6, 2023

± Registry diff

📊 Performance

Key

Note that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms.

     0s   1s   2s   3s   4s   5s   6s   7s   8s   9s
     |    |    |    |    |    |    |    |    |    |
name ▝▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▞▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▖
      compilation labelling optimization rendering

Data

                                                   0s   1s   2s   3s   4s   5s   6s   7s
                                                   |    |    |    |    |    |    |    |
3d-projection-fake-3d-linear-algebra               ▝▞▖
allShapes-allShapes                                ▝▚▚▄
arrowheads-arrowheads                              ▝▞▖
caffeine-structural-formula                        ▝▀▀▞▚
center-shrink-circle-animation                     ▝▞▖
circle-example-euclidean                           ▝▀▚▀▀▚
collinear-euclidean                                ▝▀▞▖
congruent-triangles-euclidean                      ▝▀▀▞▖
continuousmap-continuousmap                        ▝▞▖
cubic-bezier-cubic-bezier                          ▝▚▀▀▚
glutamine-molecules-basic                          ▝▀▚▚
half-adder-distinctive-shape                       ▝▚▚
hypergraph-hypergraph                              ▝▀▀▀▚▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▖
incenter-triangle-euclidean                        ▝▀▚▚
lagrange-bases-lagrange-bases                      ▝▚▚
midsegment-triangles-euclidean                     ▝▀▞▖
mobius-mobius                                      ▝▞▖
non-convex-non-convex                              ▝▚▚
one-water-molecule-atoms-and-bonds                 ▝▞▖
parallel-lines-euclidean                           ▝▀▞▚
persistent-homology-persistent-homology            ▝▀▀▞▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄
points-around-line-shape-distance                  ▝▀▞▖
points-around-polyline-shape-distance              ▝▀▀▞▖
points-around-star-shape-distance                  ▝▀▀▀▞▖
quaternion-group-group-theory-cayley-graph         ▝▀▚▚
quaternion-group-group-theory-multiplication-table ▝▀▀▚▄▚
siggraph-teaser-euclidean-teaser                   ▝▀▚▚
small-graph-disjoint-rect-line-horiz               ▝▀▚▚
small-graph-disjoint-rects                         ▝▞▖
small-graph-disjoint-rects-large-canvas            ▝▚▚
small-graph-disjoint-rects-small-canvas            ▝▞▖
tree-tree                                          ▝▚▚
tree-venn                                          ▝▀▚▚
tree-venn-3d                                       ▝▀▞▄
two-triangles-triangle-mesh-3d                     ▝▚▚
two-vectors-perp-vectors-dashed                    ▝▚▚
vector-wedge-exterior-algebra                      ▝▚▚
wet-floor-atoms-and-bonds                          ▝▚▀▚
word-cloud-example-word-cloud                      ▝▀▞▖
wos-laplace-estimator-walk-on-spheres              ▝▀▞▖
wos-nested-estimator-walk-on-spheres               ▝▀▀▚▀▀▀▖
wos-offcenter-estimator-walk-on-spheres            ▝▀▚▀▀▀▀▖
wos-poisson-estimator-walk-on-spheres              ▝▀▚▀▚

@cloudflare-pages
Copy link

cloudflare-pages bot commented Feb 6, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: c47f91f
Status: ✅  Deploy successful!
Preview URL: https://720f302a.penrose-72l.pages.dev
Branch Preview URL: https://release-guide.penrose-72l.pages.dev

View logs

@codecov
Copy link

codecov bot commented Feb 6, 2023

Codecov Report

Merging #1304 (c47f91f) into main (115a609) will decrease coverage by 0.39%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1304      +/-   ##
==========================================
- Coverage   63.43%   63.04%   -0.39%     
==========================================
  Files          61       61              
  Lines        7212     7301      +89     
  Branches     1680     1715      +35     
==========================================
+ Hits         4575     4603      +28     
- Misses       2553     2614      +61     
  Partials       84       84              
Impacted Files Coverage Δ
packages/core/src/analysis/SubstanceAnalysis.ts 66.06% <0.00%> (-8.80%) ⬇️
packages/core/src/synthesis/Synthesizer.ts 26.05% <0.00%> (-0.70%) ⬇️
packages/core/src/compiler/Style.ts 68.32% <0.00%> (-0.19%) ⬇️
packages/core/src/contrib/Utils.ts 51.35% <0.00%> (ø)
packages/core/src/shapes/Equation.ts 75.00% <0.00%> (ø)
packages/core/src/contrib/Constraints.ts 82.88% <0.00%> (ø)
packages/core/src/renderer/AttrHelper.ts 54.90% <0.00%> (ø)
packages/core/src/synthesis/Mutation.ts 48.28% <0.00%> (+0.40%) ⬆️
packages/core/src/utils/Util.ts 49.31% <0.00%> (+0.73%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@samestep samestep left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for doing this! Noted a few minor edits. Also, one additional thing to add to the docs: the yarn new-version script does not modify the Rust crate version in packages/optimizer/Cargo.{toml,lock}; those need to be updated manually.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
wodeni and others added 5 commits February 7, 2023 10:51
Co-authored-by: Sam Estep <sam@samestep.com>
Co-authored-by: Sam Estep <sam@samestep.com>
Co-authored-by: Sam Estep <sam@samestep.com>
Co-authored-by: Sam Estep <sam@samestep.com>
Co-authored-by: Sam Estep <sam@samestep.com>
@wodeni wodeni requested a review from samestep February 7, 2023 15:52
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@samestep samestep left a comment

Choose a reason for hiding this comment

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

LGTM!

@wodeni wodeni merged commit 1895d8f into main Feb 8, 2023
@wodeni wodeni deleted the release-guide branch February 8, 2023 13:48
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.

None yet

2 participants