Skip to content

Commit

Permalink
Don't add comments about API docs prewievs to PRs
Browse files Browse the repository at this point in the history
Previously we've been adding comments to PRs modifying Solidity contracts about
available previews of the API documentation. As each push to the PR branch
results in one such comment, PRs with a lot of pushes get quite busy with a lot
of the similar comments. In the future it would be good to modify our
commenting mechanism so that it would just leave one comment per PR and update
it on each push. Until we do that we're turning off the PR commenting, to
increase readability.
  • Loading branch information
michalinacienciala committed Mar 7, 2024
1 parent fa18161 commit 4d08d25
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/contracts-ecdsa-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
projectDir: /solidity/ecdsa
publish: false
addTOC: false
commentPR: true
commentPR: false
exportAsGHArtifacts: true

# This job is needed to avoid a clash of `contracts-docs-publish` jobs for
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/contracts-random-beacon-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
projectDir: /solidity/random-beacon
publish: false
addTOC: false
commentPR: true
commentPR: false
exportAsGHArtifacts: true

# This job will be triggered for releases which name starts with
Expand Down

0 comments on commit 4d08d25

Please sign in to comment.