Skip to content

Examples README samples are broken #822

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

Closed
JBBianchi opened this issue Feb 17, 2024 · 16 comments
Closed

Examples README samples are broken #822

JBBianchi opened this issue Feb 17, 2024 · 16 comments
Assignees
Labels
area: cicd Changes in the CI/CD change: documentation Improvements or additions to documentation. It won't impact a version change.
Milestone

Comments

@JBBianchi
Copy link
Member

What seems off:
The include of example sample seems to break the readme layout:
image

What you expected to be:
The layout to be nice and clean.

@ricardozanini
Copy link
Member

Hey @JBBianchi thanks for reporting it! Are you willing to fix it? :D

@JBBianchi
Copy link
Member Author

Yes, it's just a line return that needs to be added.

@RamiKassouf
Copy link

It's broken again

@JBBianchi
Copy link
Member Author

It's broken again

It hasn't been regenerated so far, so it's "still" broken :)

Copy link

github-actions bot commented May 3, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@ricardozanini
Copy link
Member

@JBBianchi is this fixed?

@JBBianchi
Copy link
Member Author

@JBBianchi is this fixed?

When #836 is merged we'll know for sure, but it should be.

@JBBianchi
Copy link
Member Author

JBBianchi commented May 8, 2024

It looks like the workflow to hydrate the readme is broken: https://github.com/serverlessworkflow/specification/actions/workflows/examples-readme-hydration.yml

Either because the BOT_PAT secret is missing or the bot doesn't have the rights on the repository.

@ricardozanini
Copy link
Member

That's weird, I'll take a look later

@cdavernas
Copy link
Member

@JBBianchi @ricardozanini Can you fix that for 0.9, meaning now, or should we close it as part of #843 ?

@JBBianchi
Copy link
Member Author

I think it would be a good thing to fix the bot config. Even if the examples are dropped with the next version, we'll still need a functioning bot in the future.

@cdavernas
Copy link
Member

@ricardozanini Can you please address that?

@ricardozanini ricardozanini added this to the v0.9 milestone May 17, 2024
@ricardozanini ricardozanini added area: spec Changes in the Specification area: cicd Changes in the CI/CD and removed area: spec Changes in the Specification labels May 17, 2024
@ricardozanini ricardozanini self-assigned this May 17, 2024
@ricardozanini ricardozanini added the change: documentation Improvements or additions to documentation. It won't impact a version change. label May 17, 2024
@ricardozanini
Copy link
Member

Closing this since we don't have this pipeline nor the examples README anymore.

@github-project-automation github-project-automation bot moved this from Backlog to Done in Progress Tracker May 29, 2024
@cdavernas
Copy link
Member

I think this must be fixed on 0.9.0

@ricardozanini
Copy link
Member

@cdavernas I'll reopen but it might stale. I'd keep it close and if there's momentum we'll notice since the CI will fail, then we can fix it. I'm investing my time on 1.0.0 atm. Feel free to reopen.

@cdavernas
Copy link
Member

cdavernas commented May 31, 2024

I'm investing my time on 1.0.0 atm

Not shit! 😆 Me too 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: cicd Changes in the CI/CD change: documentation Improvements or additions to documentation. It won't impact a version change.
Projects
Status: Done
Development

No branches or pull requests

4 participants