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

Update building documentation #1713

Merged
merged 11 commits into from
Dec 28, 2022
Merged

Update building documentation #1713

merged 11 commits into from
Dec 28, 2022

Conversation

AlekSi
Copy link
Member

@AlekSi AlekSi commented Dec 28, 2022

Description

Closes #735.
Closes #1447.

Readiness checklist

  • I added unit tests for new functionality or bug fixes.
  • I added integration tests for new functionality or bug fixes.
  • I added compatibility tests for new functionality or bug fixes.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I added/updated comments for both exported and unexported top-level declarations (functions, types, etc).
  • I checked comments rendering with task godocs.
  • I ensured that the title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Assignee, Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@AlekSi AlekSi added this to the v0.8.0 Beta milestone Dec 28, 2022
@AlekSi AlekSi self-assigned this Dec 28, 2022
@vercel
Copy link

vercel bot commented Dec 28, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
ferret-db ✅ Ready (Inspect) Visit Preview Dec 28, 2022 at 4:46PM (UTC)

@vercel vercel bot temporarily deployed to Preview December 28, 2022 10:05 Inactive
@codecov
Copy link

codecov bot commented Dec 28, 2022

Codecov Report

Merging #1713 (ba28491) into main (c50e834) will decrease coverage by 0.05%.
The diff coverage is 69.89%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1713      +/-   ##
==========================================
- Coverage   69.43%   69.37%   -0.06%     
==========================================
  Files         300      300              
  Lines       14067    14078      +11     
==========================================
  Hits         9767     9767              
- Misses       3382     3389       +7     
- Partials      918      922       +4     
Impacted Files Coverage Δ
internal/handlers/pg/msg_getlog.go 81.44% <ø> (ø)
internal/handlers/tigris/msg_getlog.go 78.78% <ø> (ø)
internal/util/telemetry/reporter.go 6.49% <0.00%> (ø)
build/version/version.go 63.01% <63.01%> (ø)
ferretdb/ferretdb.go 85.10% <100.00%> (+0.66%) ⬆️
internal/clientconn/listener.go 75.42% <100.00%> (-1.05%) ⬇️
internal/handlers/common/msg_buildinfo.go 100.00% <100.00%> (ø)
internal/handlers/common/serverstatus.go 88.23% <100.00%> (ø)
internal/handlers/pg/msg_explain.go 58.33% <100.00%> (ø)
internal/handlers/tigris/msg_explain.go 66.12% <100.00%> (ø)
... and 8 more
Flag Coverage Δ
integration 65.12% <52.17%> (-0.13%) ⬇️
mongodb 14.48% <45.65%> (+0.10%) ⬆️
pg 54.26% <51.08%> (-0.13%) ⬇️
tigris 39.17% <51.08%> (+0.16%) ⬆️
unit 29.28% <63.44%> (+0.13%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@vercel vercel bot temporarily deployed to Preview December 28, 2022 13:57 Inactive
@vercel vercel bot temporarily deployed to Preview December 28, 2022 14:20 Inactive
@AlekSi AlekSi added documentation Something user-visible is badly or not documented code/enhancement Some user-visible feature could work better labels Dec 28, 2022
@vercel vercel bot temporarily deployed to Preview December 28, 2022 14:34 Inactive
@AlekSi AlekSi marked this pull request as ready for review December 28, 2022 14:35
@AlekSi AlekSi requested a review from a team December 28, 2022 14:35
@AlekSi AlekSi requested a review from a team as a code owner December 28, 2022 14:35
@AlekSi AlekSi enabled auto-merge (squash) December 28, 2022 14:35
@AlekSi AlekSi requested review from a team and noisersup and removed request for a team December 28, 2022 14:35
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

Asked a few questions, not a full review yet.

README.md Outdated Show resolved Hide resolved
build/version/version.go Show resolved Hide resolved
build/version/version.go Show resolved Hide resolved
@AlekSi AlekSi disabled auto-merge December 28, 2022 16:07
@AlekSi AlekSi enabled auto-merge (squash) December 28, 2022 16:08
@vercel vercel bot temporarily deployed to Preview December 28, 2022 16:46 Inactive
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

Both the code and the docs look good to me. I like how we reference godoc docs to share more info about build tags etc!

@AlekSi AlekSi merged commit 1293a5e into FerretDB:main Dec 28, 2022
@AlekSi AlekSi deleted the build-tags branch December 28, 2022 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/enhancement Some user-visible feature could work better documentation Something user-visible is badly or not documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update building documentation Manually upload binaries for releases
3 participants