sfeir-open-source / sfeir-school-github-action-dev

SFEIR School GitHub Action Dev

Discover the SFEIR Schools

Slides

You can view the slides here.

Develop

To run docs locally, go in directory docs and run npx serve of if you don't have node, you can use docker docker-compose up, and open slides on http://localhost:5000/.

Labs

Labs are in directory steps :

• two directories per labs :
  • one with a README.md with workshop steps and source file to complete
  • a second directory suffixed with -solution which contains source file with solutions.

Contributing

Contributing Guidelines

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our Code of Conduct.

sfeir-school-github-action-dev's Issues

Find a way to ease the lab setup

Currently the setup of each lab is a task without interest and need to be automated to let the student focus on the lab itself.

default branch name should be "main"

sfeir-school-github-action-dev/steps/50-lifecycle-lab1-marketplace-solution/.github/workflows/release-workflow.yml

Line 12 in f3a40a3

if: github.ref == 'refs/heads/master'

Document the fact that multiple versions of GH exists and the impact on the action

For public actions, we need to keep in mind that GitHub exists in multiple versions like the GHES (GitHub Entreprise Server).

For example, currently, $GITHUB_OUTPUT is not valid on GHES, so a public action needs to manage that. @actions/toolkit supports it by design.

if [ -f "$GITHUB_OUTPUT" ]; then
  echo "key=${value}" >>"$GITHUB_OUTPUT"
else
  echo "::set-output name=key::${value}"
fi

Build fail on bats submodules

I think I misconfigured them during the cleanup for the v1.0.0

Take in account the deprecation of save-state and set-output commands

https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

related to #45

Update toolkit/core to latest version

Currently the version is fixed by #42 to avoid issues that seem to be related to the next implementation of setOutput function

• actions/runner#2118
• actions/toolkit#1178

This change is linked to a Security advisory : GHSA-7r3h-m5j6-3q42

github.token is read-only on new repositories

Read https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ for more information

Find a way to test labs code and solution without duplication

To improve maintainability to this school

[Bug]: GitHub Actions Linter / lint-a-action (pull_request) on dependabot PR

Describe the bug

Dependabot PR fail to run GitHub Actions Linter / lint-a-action (pull_request)

Reproduction steps

No response

Expected behavior

GitHub Actions Linter / lint-a-action (pull_request) working on dependabot PR

Screenshots

No response

System information

No response

Additional context

No response

Improve screenshots of nested reusable workflows

Due to new design (https://github.blog/changelog/2022-10-13-design-improvements-to-github-actions-navigation/), we can change the associated screenshots

Rework labs

Ideas

• Keep only one lab per section
  • Or make the next one optional
• Add context to the lab (like reuse lab 1)

Some markdown for the speaker slides are visible on the normal slide

Some slides display the Notes: blocks. Need to analyze when and because of what.

Display result of using deprecated input

On slide about deprecated input, add an image of the result of this use.

Add link to sample on slide with code

On slides with code, when the presented code came from a working sample, we can add credits link to the code itself.

Slide

sfeir-school-github-action-dev/docs/markdown/30-testing/01-javascript.md

Lines 33 to 36 in d6d2431

	- uses: ./.github/actions/operations
	with:
	input1: 9
	input2: 5

Code

sfeir-school-github-action-dev/.github/workflows/operations-testing.yaml

Lines 23 to 27 in d6d2431

	- uses: ./.github/actions/operations
	id: test
	with:
	input1: 5
	input2: 9

Add Actionlint tool to testing section

Actionlint is a linter for your action to help you with a set of recommendations on GitHub Actions ecosystem

https://rhysd.github.io/actionlint/

On Lab 1 of livecycle, add rules to generate a commit

Tell the student the rules to generate a new release

• releasable branch (also see #32)
• commit message

Use theme v3

• Migration #6
• Improve existing slides with new features (two-column layout, highlight of code) #7