Skip to content

Conversation

Tofel
Copy link
Contributor

@Tofel Tofel commented Sep 18, 2024

This PR introduces a reusable Solidity Review Artifact generating pipeline that currently was stored in chainlink repository.

I have made it more universal, so that it's possible to use with repositories that use different project structure (chainlink repo is very specific in that regard).

I have tested it with typical Foundry layout and it works like a charm. Here's a working example: https://github.com/smartcontractkit/solidity-review-artifacts-example that also describes how to use this pipeline in any repository.

Apart from the workflow itself I had to move a couple of scripts and actions:

  • bash scripts used by the pipeline
  • actions used to setup the pipeline
  • TypeScript code that's responsible for interaction with Jira

You can find some sample executions here: https://github.com/smartcontractkit/solidity-review-artifacts-example/actions/workflows/solidity-review-artifacts.yml

@Tofel Tofel requested a review from a team as a code owner September 18, 2024 15:38
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch from ed461ed to f2887cf Compare September 18, 2024 16:12
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch from 99c452e to 4ffaa92 Compare September 18, 2024 16:45
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch from 4ffaa92 to 058dd78 Compare September 18, 2024 16:49
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch from 88ccb7b to 09b882e Compare September 18, 2024 16:56
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch 7 times, most recently from 5dea933 to 04fa279 Compare September 19, 2024 08:23
@Tofel Tofel force-pushed the tt_1693_reusable_solidity_artifacts_workflow branch from 04fa279 to 9c0d065 Compare September 19, 2024 09:24
Copy link
Contributor

@scheibinger scheibinger left a comment

Choose a reason for hiding this comment

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

Looks good in general, just posted one question.

It's pretty complex setup, would be nice if you can add a CODEOWNER entry for all the files added in this PR, so we can easily tag the right people to review changes in it.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Tofel Have you considered packaging this as a Typescript based action instead of a lib?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have not, because I have copied that code from chainlink repo. It was originally created by @momentmaker and @HenryNguyen5 and I didn't want to modify more things than strictly necessary.

@scheibinger scheibinger enabled auto-merge (squash) September 20, 2024 11:51
@scheibinger scheibinger merged commit c3786fd into main Sep 20, 2024
12 checks passed
@scheibinger scheibinger deleted the tt_1693_reusable_solidity_artifacts_workflow branch September 20, 2024 11:52
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