Add link to docs on how to run locally to attach a JVM debugger #506
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When debugging the behaviour of Scala Steward, it can be helpful to run Scala Steward locally, while mimicking the settings used by the Scala Steward GitHub Action, so that a debugger can be attached.
|
A snapshot release has been created as You can test it out with: uses: scala-steward-org/scala-steward-action@snapshots/506It will be automatically recreated on any change to this PR. |
|
|
Hey @rtyley, thanks for this, that guide looks fantastic! I'm wondering if this could sit better in the |
|
I did originally plan on putting it in
https://github.com/scala-steward-org/scala-steward/blob/main/docs/running.md
, but because the instructions are specific to mimicking the GitHub Action,
and there might be users *not* using GHAs reading that file, I had to add a
bit of explanatory context to make the motivation a bit clearer - in the
end, it seemed more appropriate to keep the instructions in a docs location
specific to GHAs?
…On Fri, 30 Jun 2023, 08:49 Alejandro Hernández, ***@***.***> wrote:
Hey @rtyley <https://github.com/rtyley>, thanks for this, that guide
looks fantastic! I'm wondering if this could sit better in the
scala-steward repository, as part of the documentation, so it gets to a
broader audience, wdyt?
—
Reply to this email directly, view it on GitHub
<#506 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAMWRXZKE2LYHIV6G3FGGTXN2AJXANCNFSM6AAAAAAZYQ5F6Q>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Ok, yeah, that makes total sense 😊 Merging now! Thank you very much! |
alejandrohdezma
approved these changes
Jun 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When debugging the behaviour of Scala Steward in production, it can be helpful to run Scala Steward locally, while mimicking the settings used by the Scala Steward GitHub Action, so that a debugger can be attached - here's a link to some docs we wrote at the Guardian on this, which may be helpful to others:
https://github.com/guardian/scala-steward-public-repos/blob/main/running-locally.md