Skip to content

Commit

Permalink
updated versions for release
Browse files Browse the repository at this point in the history
  • Loading branch information
chrispyles committed Feb 14, 2022
1 parent 7ff1c97 commit fb01d69
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog

## 0.1 - Unreleased
## 0.1 - 2022-02-13

* Initial release
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@

An action for running [PyBryt](https://microsoft.github.io/pybryt) as an automated assessment tool on GitHub repositories.

### GitHub Actions
If your not familar with GitHub Actions or Workflows we advise you to complete this short awarness module [GitHub Actions, Microsoft Learn Module](https://docs.microsoft.com/learn/modules/introduction-to-github-actions) By the end of this module, you'll be able to:

- Explain GitHub Actions and workflows
- Create and work with GitHub Actions and Workflows
- Describe Events, Jobs and Runners
- Examine output and release management for actions

## Usage of PyBryt GitHub Action

The PyBryt action accepts the following inputs:
Expand All @@ -36,7 +28,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Run PyBryt
uses: microsoft/pybryt-action@main # TODO: update the version
uses: microsoft/pybryt-action@v0.1
with:
submission-path: demo/fibonacci/submissions/subm01.ipynb
references: |
Expand All @@ -49,7 +41,7 @@ If you were using a notebook as a testing harness, you may want something like:

```yaml
- name: Run PyBryt
uses: microsoft/pybryt-action@main # TODO: update the version
uses: microsoft/pybryt-action@v0.1
with:
submission-path: harness.ipynb
additional-files: |
Expand All @@ -75,7 +67,7 @@ For example, you may want to commit these as files in the student's repo:
```yaml
- name: Run PyBryt
id: pybryt
uses: microsoft/pybryt-action@main # TODO: update the version
uses: microsoft/pybryt-action@v0.1
with:
# etc.
- name: Save, commit, and push results
Expand Down Expand Up @@ -106,9 +98,19 @@ with open(os.path.join(RESULTS_DIR, "results.pkl"), "rb") as f:

student_impl = pybryt.StudentImplementation.load(os.path.join(RESULTS_DIR, "student-implementation.pkl"))
```
## Enhancing your Github Actions

If you are interesting, in learning how GitHub Actions enables you to automate your software development cycle and deploy applications we recommend the following short course [Automate your workflow with GitHub Actions](https://docs.microsoft.com/learn/paths/automate-workflow-github-actions/)
You can learn more about how to use this action in [PyBryt's Documentation](https://microsoft.github.io/pybryt/html/github_action.html).

## About GitHub Actions

If you're not familiar with GitHub Actions or Workflows we advise you to complete this short awareness module: [GitHub Actions, Microsoft Learn Module](https://docs.microsoft.com/learn/modules/introduction-to-github-actions). By the end of this module, you'll be able to:

- Explain GitHub Actions and workflows
- Create and work with GitHub Actions and Workflows
- Describe Events, Jobs and Runners
- Examine output and release management for actions

If you are interesting, in learning how GitHub Actions enables you to automate your software development cycle and deploy applications we recommend the following short course: [Automate your workflow with GitHub Actions](https://docs.microsoft.com/learn/paths/automate-workflow-github-actions/).

In this learning path, you'll:

Expand Down

0 comments on commit fb01d69

Please sign in to comment.