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

Make example usage self contained #164

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

aliphys
Copy link

@aliphys aliphys commented Aug 28, 2023

What is the problem?

What This PR Changes

  • I have elaborated upon the example to make it self contained. This includes:
    • Fully defining the jobs: entry, alongside the on: and name: items
    • Adding comments describing what the .yml file does, without assuming prior knowledge with GitHub Actions
    • Enabling the workflow_dispatch: option, so users can manually run the workflow

Note: I have a repo here, where the .yml file is fully tested alongside example sketches.

@per1234 per1234 changed the title [AE-170][AE-158] Make example usage self contained Make example usage self contained Oct 23, 2023
@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Nov 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants