Start area for grading actions #28
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… a single boolean response
|
@FidelusAleksander Please take a look and provide feedback about how we want to introduce this concept into the toolkit. |
There was a problem hiding this comment.
I think this has potential.
Let's not merge this yet, I will experiment with grading workflows too - In this implementation I worry that this is too specific to the use case. The jsons are matching between two different actions and built in a way to match what the markdown template requires.
Comment on lines
9
to
13
| - `check-name`: The name of the check that will appear in the results | ||
| - `setting-name`: The full path to the [repository setting](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository) to check, using dot notation. Example `owner.login` | ||
| - `setting-expected-value`: The expected value of the repository setting | ||
| - `pass-message`: The message to return if the check passes | ||
| - `fail-message`: The message to return if the check fails |
There was a problem hiding this comment.
I think this may be too specific to the use case.
Initial thoughts is to keep the action to only check the setting value
And the outputs would be:
- passed: boolean
- actual-value: string (not sure about this one)
Suggested change
| - `check-name`: The name of the check that will appear in the results | |
| - `setting-name`: The full path to the [repository setting](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository) to check, using dot notation. Example `owner.login` | |
| - `setting-expected-value`: The expected value of the repository setting | |
| - `pass-message`: The message to return if the check passes | |
| - `fail-message`: The message to return if the check fails | |
| - `setting-name`: The full path to the [repository setting](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository) to check, using dot notation. Example `owner.login` | |
| - `setting-expected-value`: The expected value of the repository setting |
Suggested change
| - `check-name`: The name of the check that will appear in the results | |
| - `setting-name`: The full path to the [repository setting](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository) to check, using dot notation. Example `owner.login` | |
| - `setting-expected-value`: The expected value of the repository setting | |
| - `pass-message`: The message to return if the check passes | |
| - `fail-message`: The message to return if the check fails | |
| - `setting-key`: The full path to the [repository setting](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository) to check, using dot notation. Example `owner.login` | |
| - `setting-expected-value`: The expected value of the repository setting |
| ```yml | ||
| - name: Overall Check | ||
| id: check-combined-results | ||
| uses: skills/exercise-toolkit/.github/workflows/grading/check-all-results@cwb |
There was a problem hiding this comment.
I'm not sure but I think this entire action can be replaced by
` if: steps.*.outcome != 'success'`
|
As discussed the GITHUB_TOKEN in github actions does not allow to view repository settings |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces two new GitHub Actions to support grading workflows: "Check all Results" and "Check Repository Setting". The changes include the addition of action definitions and documentation to guide users on how to implement these actions.
New GitHub Actions:
Check all Results Action:
action.ymlto define the "Check all Results" action, which aggregates the results of multiple grading actions and returns a boolean indicating if all checks have passed.README.mdto document the usage.Check Repository Setting Action:
action.ymlto define the "Check Repository Setting" action, including required and optional inputs, and the logic to check the repository setting.README.mdto document the usage.