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

Improved documentation and checklist for releasing a new version #343

Merged
merged 2 commits into from
Sep 23, 2022

Conversation

metachris
Copy link
Collaborator

📝 Summary

Improved documentation and checklist for release process


✅ I have run these commands

  • make lint
  • make test-race
  • go mod tidy

@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2022

Codecov Report

Merging #343 (3bc7425) into main (7a95875) will decrease coverage by 0.14%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #343      +/-   ##
==========================================
- Coverage   82.05%   81.91%   -0.15%     
==========================================
  Files           5        5              
  Lines         680      680              
==========================================
- Hits          558      557       -1     
- Misses         92       94       +2     
+ Partials       30       29       -1     
Flag Coverage Δ
unittests 81.91% <ø> (-0.15%) ⬇️

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

Impacted Files Coverage Δ
server/service.go 80.04% <0.00%> (-0.25%) ⬇️

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

@metachris metachris merged commit 87c5d88 into main Sep 23, 2022
@metachris metachris deleted the improved-release-process-docs branch September 23, 2022 06:30
kailinr pushed a commit that referenced this pull request Sep 25, 2022
* improved documentation around release process

* RELEASE.md
metachris added a commit that referenced this pull request Sep 25, 2022
* Update README.md (#334)

* Readme Usage updat

* Add security audit, make clone section more explicit

* update MEV vs mev, adjust language, typos

* remove The Plan

* correct line 17 capitalization

* Add space to line 182

Co-authored-by: shana <[email protected]>

* add security link to line 20

* Rmve TOC header from line 40

* Remve checkout release instructions from line 111

* add beacon node to distinction to ln 16

* update line 17, change markdown of line 47-49 titles

* remove mrkdown line 205 by chris

Co-authored-by: Chris Hager <[email protected]>

* getPayload only to origin relays (#342)

* v1.3.2

* v1.3.3-dev

* Improved documentation and checklist for releasing a new version (#343)

* improved documentation around release process

* RELEASE.md

* readme: link to remroy's guide (#344)

* Print relays/monitors on individual lines (#349)

* release checklist: create a signed tag (#346)

* Add gofumpt to lint checks (#347)

* Remove unnecessary log.withField calls (#350)

Co-authored-by: Chris Hager <[email protected]>

* fix the spelling of 'Rémy Roy'

* line 81 header

* address Chris's comments

Co-authored-by: Nicolas Moreau <[email protected]>
Co-authored-by: shana <[email protected]>
Co-authored-by: Chris Hager <[email protected]>
Co-authored-by: Justin Traglia <[email protected]>
screwyprof pushed a commit to screwyprof/mev-boost that referenced this pull request Feb 3, 2023
…shbots#343)

* improved documentation around release process

* RELEASE.md
screwyprof pushed a commit to screwyprof/mev-boost that referenced this pull request Feb 3, 2023
…#339)

* Update README.md (flashbots#334)

* Readme Usage updat

* Add security audit, make clone section more explicit

* update MEV vs mev, adjust language, typos

* remove The Plan

* correct line 17 capitalization

* Add space to line 182

Co-authored-by: shana <[email protected]>

* add security link to line 20

* Rmve TOC header from line 40

* Remve checkout release instructions from line 111

* add beacon node to distinction to ln 16

* update line 17, change markdown of line 47-49 titles

* remove mrkdown line 205 by chris

Co-authored-by: Chris Hager <[email protected]>

* getPayload only to origin relays (flashbots#342)

* v1.3.2

* v1.3.3-dev

* Improved documentation and checklist for releasing a new version (flashbots#343)

* improved documentation around release process

* RELEASE.md

* readme: link to remroy's guide (flashbots#344)

* Print relays/monitors on individual lines (flashbots#349)

* release checklist: create a signed tag (flashbots#346)

* Add gofumpt to lint checks (flashbots#347)

* Remove unnecessary log.withField calls (flashbots#350)

Co-authored-by: Chris Hager <[email protected]>

* fix the spelling of 'Rémy Roy'

* line 81 header

* address Chris's comments

Co-authored-by: Nicolas Moreau <[email protected]>
Co-authored-by: shana <[email protected]>
Co-authored-by: Chris Hager <[email protected]>
Co-authored-by: Justin Traglia <[email protected]>
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