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.

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

Add instructions for developing with a local version of the action #250

Merged
merged 5 commits into from
Nov 17, 2023

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Oct 18, 2023

Summary

This PR introduces instructions for developing with a local version of the action to improve the development experience. No longer are pushes and tags to a remote branch necessary.

These changes allow custom configurations to be made to the event payloads to test various cases, and different techniques can be tried with changes to the local.yml file.

At the moment only a simple payload is provided to mock Technique 1. I think this is alright to start as more events could be added over time, or experiments can just be performed locally.

Open to any thoughts on this!

Requirements

@zimeg zimeg added documentation Improvements or additions to documentation discussion semver:patch labels Oct 18, 2023
@zimeg zimeg added this to the 1.25 milestone Oct 18, 2023
@zimeg zimeg self-assigned this Oct 18, 2023
Copy link
Member

@seratch seratch 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 to me; it seems the CI builds are failing now although perhaps your changes are unrelated


**Requirements**:

- An installation of [nektos/act](https://github.com/nektos/act)
Copy link
Member

Choose a reason for hiding this comment

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

I didn't know this tool 👍

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Good additions 💯

Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

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

LGTM but yeah we should check the integration test failures

@zimeg
Copy link
Member Author

zimeg commented Oct 19, 2023

@seratch @WilliamBergamin @filmaj Thank y'all for the reviews! The failing integration tests are strange, but I believe this is caused by this PR coming from a fork.

From the "Actions" tab in settings:

Anyone with collaborator access to this repository can use these secrets and variables for actions. They are not passed to workflows that are triggered by a pull request from a fork.

It looks like there's a workaround that requires some additions to the workflow file, which might be useful for future contributions! I'll open a new issue to track changes around this, but since this PR doesn't change current behaviors I think it's fine to merge as is.

@filmaj
Copy link
Contributor

filmaj commented Oct 20, 2023

Hmm that is odd. Usually there is a 'allow the tests to run for this PR' in the case that the PR comes from a fork.

@zimeg
Copy link
Member Author

zimeg commented Nov 17, 2023

Going to merge this as is since I believe the integration tests are failing due to secrets not being shared with actions run by forks, not from the changes within. Will quickly revert it if failures continue, but continuing research into the failed integration tests in #258 🔍

@zimeg zimeg merged commit 813c9c1 into slackapi:main Nov 17, 2023
2 of 6 checks passed
@zimeg zimeg deleted the local-run branch November 17, 2023 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation Improvements or additions to documentation semver:patch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants