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

Document example workflows with upload and also test them #136

Merged
merged 7 commits into from
Jun 14, 2021

Conversation

sverhoeven
Copy link
Member

@sverhoeven sverhoeven commented Jun 11, 2021

Refs #79

Description

  • Shows how to get the HTML files out of a workflow.
  • Make the workflows shown in README the same as those in .github/workflows/usage.yml.
  • The .github/workflows/usage.yml workflow no longer runs on each PR as .github/workflows/testing.yml tests the action much better. It can still be triggered manually see https://github.com/tortellini-tools/action/actions/runs/927859407 and will be run when main branch is changed.

Before you get started

Checklist

This section should be filled in by the creator of this pull request to make sure the pull request is ready to review.

  • This pull request has a descriptive title
  • Code is written according to the code quality guidelines
  • Documentation if applicable is available
  • Tests run successfully
  • All checks below this pull request were successful

Instructions to review the pull request

@sverhoeven sverhoeven marked this pull request as ready for review June 11, 2021 08:32
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@jspaaks jspaaks left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I left a couple of comments. Apart from those, should we consider offering the two usage cases as separate workflow files? something like usage-current-repository.yml and usage-multiple-repositories.yml? (we can leave that for another day, just wanted to get your opinion)

@sverhoeven
Copy link
Member Author

Thanks for the PR. I left a couple of comments. Apart from those, should we consider offering the two usage cases as separate workflow files? something like usage-current-repository.yml and usage-multiple-repositories.yml? (we can leave that for another day, just wanted to get your opinion)

Thanks for the comments, I addressed all of them.
I like you proposal. We are showing complete workflows in the README having them separated in .github/workflows make sense. It will make it easier to keep them the same (README vs .github/workflows).

@sverhoeven sverhoeven requested a review from jspaaks June 14, 2021 12:08
Copy link
Member

@jspaaks jspaaks left a comment

Choose a reason for hiding this comment

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

Good stuff, thank you Stefan!

@sverhoeven sverhoeven merged commit 673326f into main Jun 14, 2021
@sverhoeven sverhoeven deleted the 79-worklow-upload-artifact-readme branch June 14, 2021 13:35
This was referenced Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants