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

Example code misnamed #361

Closed
rdavison opened this issue Nov 21, 2024 · 3 comments · Fixed by #376
Closed

Example code misnamed #361

rdavison opened this issue Nov 21, 2024 · 3 comments · Fixed by #376
Labels
documentation Improvements or additions to documentation

Comments

@rdavison
Copy link

Description

Several examples in the example code have JSON in the filename, but the payload content is actually YAML.

Screenshot 2024-11-21 at 3 35 23 PM

@zimeg zimeg added the documentation Improvements or additions to documentation label Nov 21, 2024
@zimeg
Copy link
Member

zimeg commented Nov 21, 2024

Hey @rdavison 👋 Thanks for catching this - the filenaming might've been missed with recent changes here 😅

We'll update these examples and related documentation super soon to make sure examples like this are clear! 📚

@zimeg
Copy link
Member

zimeg commented Nov 21, 2024

As a quick reference, this example can be written with JSON like so:

on: [push]

jobs:
  new_push_job:
    runs-on: ubuntu-latest
    name: New push to repo
    steps:
      - name: Send GitHub trigger payload to Slack Workflow Builder
        id: slack
        uses: slackapi/slack-github-action@v2.0.0
        with:
          webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
          webhook-type: webhook-trigger
          payload: |
            {
              "key": "value",
              "foo": "bar"
            }

@zimeg
Copy link
Member

zimeg commented Dec 20, 2024

👋 Thanks again for sharing this finding!

The example workflows were revamped with other changes, so I think we can close this now. Please do feel free to write in with other strangnesses noticed though! This is always appreciated 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants