Skip to content

Releases: skills/exercise-toolkit

v0.7.0

04 Jul 09:38
f7e5b28
Compare
Choose a tag to compare

What's Changed

💥 Breaking changes

  • refactor!: rewrite markdown-templates/step-feedback/step-results-table.md to Nunjucks syntax, remove required top-level passed argument (#70)

Important

This version introduced breaking changes in this markdown-templates/step-feedback/step-results-table.md template for Mustache syntax renderers.
If you were using this template with skills/action-text-variables@v2 you will have to update to using next major version skills/action-text-variables@v3 which substituted Mustache for Nunjucks templating RELEASE NOTES

Note

Starting from this release, markdown-templates/step-feedback/step-results-table.md can also be used with GrantBirki/comment action, which also uses Nunjucks templating

Starting from this release, the top level passed argument is not needed. The template determines if all steps passed by checking if all passed keys in results_table items are equal set to true

Example:

  - name: Get response templates
    uses: actions/checkout@v4
    with:
      repository: skills/exercise-toolkit
      path: exercise-toolkit
      ref: v0.7.0

  - name: Update comment - step results
    uses: GrantBirki/comment@v2.1.1
    with:
      repository: ${{ env.ISSUE_REPOSITORY }}
      issue-number: ${{ env.ISSUE_NUMBER }}
      comment-id: ${{ steps.find-last-comment.outputs.comment-id }}
      edit-mode: replace
      file: exercise-toolkit/markdown-templates/step-feedback/step-results-table.md
      vars: |
        step_number: 2
        results_table:
          - description: "Checked if README.md file exists"
            passed: ${{ steps.check-file-exists.outcome == 'success' }}
          - description: "Checked for Installation guide in README.md"
            passed: ${{ steps.check-for-keyphrase.outcome == 'success' }}

📋 Markdown Templates

  • refactor: move the socials text from finish-exercise workflow to the exercise-finished template (#76)
  • fix: move to nunjucks template syntax for issue URL in exercise-started.md (#77)
  • refactor: update GitHub Skills link to point to the GitHub Learn URL (#75)
  • refactor!: rewrite markdown-templates/step-feedback/step-results-table.md to Nunjucks syntax, remove required top-level passed argument (#70)

⚙️ Reusable Workflows

  • refactor: move the socials text from finish-exercise workflow to the exercise-finished template (#76)

📚 Documentation

  • docs: update documentation to mention moving to Nunjucks templating and include usage with GrantBirki/comment (#72)

📦 Dependency updates

  • chore(deps): bump skills/action-text-variables from 2 to 3 (#73)

v0.6.0

25 Jun 15:44
ebf43bb
Compare
Choose a tag to compare

What's Changed

📋 Markdown Templates

  • style: enhance welcome message styling (#67)
  • feat: add share to LinkedIn button in final README (#63)
  • feat: add share to BlueSky button in final README (#61)
  • refactor: restructure the exercise-finished README template (#60)
  • feat: add share to X button in final README (#57)

⚙️ Reusable Workflows

  • fix: update find-exercise workflow to also work on closed issues (#71)
  • feat: add exercise-title optional parameter to finish-exercise workflow (#65)

🛠️ Actions

  • feat: add repository-elapsed-time action (#58)

🔧 Maintenance

  • chore: remove breaking from release-drafter version resolver (#66)
  • chore: modify _update-self-references workflow to use a PAT (#54)
  • chore: update workflows to use dynamic EXERCISE_TOOLKIT_REF environment variable, add a workflow to update it (#51)

v0.5.0

28 May 10:47
a7add33
Compare
Choose a tag to compare

What's Changed

📋 Markdown Templates

  • fix: remove @ mention from readme template as tagging users in README does not work (#49)

⚙️ Reusable Workflows

  • feat: add update-readme-with-congratulations feature flag tofinish-exercise workflow (#38)

🛠️ Actions

  • feat: add file-exists action (#40)

🔧 Maintenance

  • chore(deps): bump super-linter/super-linter from 7.3.0 to 7.4.0 (#47)
  • chore: add actions label to labeler and release drafter configurations (#46)

v0.4.0

29 Apr 15:25
a112ab1
Compare
Choose a tag to compare

What's Changed

📋 Markdown Templates

  • feat: lower the inflatocat image size in step-results-table (#34)
  • feat: rename step-results template to step-results-table and simplify it (#29)
  • feat: update greeting format to include '@' for user mentions in templates (#27)

⚙️ Reusable Workflows

  • ci: prepare v0.4.0 release (#37)
  • chore: update self references of exercise toolkit to latest commit (#31)

🔧 Maintenance

  • ci: update release-drafter configuration with version-resolver (#35)

📚 Documentation

  • docs: update README with table of contents and notable resources section (#36)

📦 Dependency updates

  • chore: upgrade action-text-variables to v2 and update variable syntax in workflows (#32)

v0.3.0

09 Apr 10:44
4446414
Compare
Choose a tag to compare

What's Changed

📋 Markdown Templates

⚙️ Reusable Workflows

  • update start-exercise workflow to use updated exercise-started template with simplified footer (#26) @FidelusAleksander
  • update finish-exercise workflow to use exercise-finished README template (#25) @FidelusAleksander

Full Changelog: v0.2.0...v0.3.0

v0.2.0

07 Apr 08:39
5b3980a
Compare
Choose a tag to compare

What's Changed

⚙️ Reusable Workflows

🔧 Maintenance

Full Changelog: v0.1.0...v0.2.0

v0.1.0

19 Mar 14:34
1c205f3
Compare
Choose a tag to compare

First release 🎉

We're excited to announce the first release of the GitHub Skills Exercise Toolkit, designed to streamline the creation and management of Skills exercises.

What's Included

⚙️ Reusable Workflows

This release includes three powerful reusable workflows:

  • .github/workflows/start-exercise.yml

    • Disables all exercise step GitHub Workflows
    • Creates GitHub Issue for the exercise
    • Updates README links and buttons
  • .github/workflows/finish-exercise.yml

    • Closes the exercise issue automatically
    • Congratulates the learner in the README
  • .github/workflows/find-exercise-issue.yml

    • Finds the exercise issue
    • Outputs issue-url and issue-number values for use in other workflows

📋 Markdown Templates

All markdown templates have been migrated from the skills/response-templates repository and are now available in this toolkit.

Templates include:

  • Issue templates
  • Response templates for automated interactions