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.

Sign up for GitHub

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

Jump to bottom

feat(ci): check deploy markdown correctness #2373

Merged
merged 2 commits into from
Mar 31, 2022
Merged

feat(ci): check deploy markdown correctness #2373

merged 2 commits into from
Mar 31, 2022

Conversation

smartcontracts
Copy link
Contributor

Description
Adds a step to the contract tests to confirm that the contract
deployment docs are up to date. Will only fail if a deployment has been
modified but yarn autogen:markdown was not run properly.

@changeset-bot
Copy link

changeset-bot bot commented Mar 26, 2022 •
edited

⚠️ No Changeset found

Latest commit: 5b14675

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@smartcontracts
Copy link
Contributor Author

Nice! Works as expected.

@smartcontracts smartcontracts mentioned this pull request Mar 27, 2022
Closed
@codecov-commenter
Copy link

codecov-commenter commented Mar 27, 2022 •
edited

Codecov Report

Merging #2373 (4f5889e) into develop (6a839b1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2373   +/-   ##
========================================
  Coverage    80.14%   80.14%           
========================================
  Files           77       77           
  Lines         2458     2458           
  Branches       450      450           
========================================
  Hits          1970     1970           
  Misses         488      488
Flag Coverage Δ
contracts 99.29% <ø> (ø)
core-utils 86.77% <ø> (ø)
data-transport-layer 49.72% <ø> (ø)
sdk 55.90% <ø> (ø)

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

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 6a839b1...4f5889e. Read the comment docs.

@smartcontracts smartcontracts marked this pull request as ready for review March 31, 2022 18:16
@tynes
Copy link
Contributor

tynes commented Mar 31, 2022

Needs a rebase for tests to work

@mergify mergify bot requested a review from cfromknecht March 31, 2022 19:03
@mergify
Copy link
Contributor

mergify bot commented Mar 31, 2022

This PR has been added to the merge queue, and will be merged soon.

@smartcontracts @mslipper
feat(ci): check deploy markdown correctness
893774c 
Adds a step to the contract tests to confirm that the contract
deployment docs are up to date. Will only fail if a deployment has been
modified but yarn autogen:markdown was not run properly.
@smartcontracts @mslipper
maint(ct): update deployments markdown
5b14675 
Updates the deployments markdown files. Should've been updated after we
deployed the Teleportr contracts to Kovan but we didn't have the CI
workflow in place to detect that this didn't happen.
@mergify mergify bot merged commit 917058e into develop Mar 31, 2022
@mergify mergify bot deleted the sc/ci-check-deploy-docs branch March 31, 2022 22:59
@mergify
Copy link
Contributor

mergify bot commented Mar 31, 2022

This PR is next in line to be merged, and will be merged as soon as checks pass.

@mslipper mslipper mentioned this pull request Apr 1, 2022
Merged
@mds1 mds1 mentioned this pull request Apr 5, 2022
Open
nebojsa94 pushed a commit to Tenderly/optimism that referenced this pull request Apr 26, 2022
@smartcontracts @nebojsa94
feat(ci): check deploy markdown correctness (ethereum-optimism#2373)
310adb3 
* feat(ci): check deploy markdown correctness

Adds a step to the contract tests to confirm that the contract
deployment docs are up to date. Will only fail if a deployment has been
modified but yarn autogen:markdown was not run properly.

* maint(ct): update deployments markdown

Updates the deployments markdown files. Should've been updated after we
deployed the Teleportr contracts to Kovan but we didn't have the CI
workflow in place to detect that this didn't happen.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mslipper mslipper mslipper approved these changes

@tynes tynes tynes approved these changes

@maurelian maurelian Awaiting requested review from maurelian

@cfromknecht cfromknecht Awaiting requested review from cfromknecht

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@smartcontracts @codecov-commenter @tynes @mslipper