update: README.md and CONTRIBUTING.md #149
Conversation
Signed-off-by: Melissa Kilby <[email protected]>
|
|
||
| When you create a bug report, please provide the following: | ||
|
|
||
| - **swift-prometheus commit hash** you are using. |
There was a problem hiding this comment.
All great detail, and we should include a PR template that specifically asks for this detail as well
There was a problem hiding this comment.
I was thinking about it. Let’s keep track of creating a more formal template in /swiftlang or /apple?
(We are currently exploring the possibility of having this client accepted into the Prometheus project. Consequently, the Contributing guidance may undergo further modifications if this outcome materializes.)
| ``` | ||
|
|
||
| - **Simulate CI Workflows (Optional)**: For a more comprehensive check, you can run the full GitHub Actions workflows locally using [act](https://github.com/nektos/act). This is useful for catching issues that only appear in the CI environment. | ||
| - For detailed setup instructions, see the Swift project's guide on [Running Workflows Locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally). |
There was a problem hiding this comment.
I tried the whole sequence with act and really struggled to get it working with anything OTHER than docker-desktop - I love the concept of describing this and providing a means to check the workflows locally, but it was particularly cranky for me.
I'm not immediately clear on what other options there might be, or how to make that process work a bit more smoothly - say for example, using container instead of docker and what might need to exist to arrange that. That's probably beyond the scope of this edit though.
There was a problem hiding this comment.
That's probably beyond the scope of this edit though.
I would say so, yes.
Should we open a new issue against https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally just to keep track of the callouts?
(We should consider proposing various cross-platform solutions.)
|
I unbroke the nightly benchmarks; #153 |
|
Lgtm |
3 participants
update: README.md and CONTRIBUTING.md
Fixes #148
CC @ktoso @heckj