j12y VS checkout

The configuration file for my project is .github/workflows/build-readme.yml. The folder naming convention is critical, but the YAML file can be named to suit the purpose and there may be multiple workflows kept in separate configuration files.

and configured tsconfig.json and package.json to run my build with npm start by executing:

To checkout the merged commit with actions/checkout on pull_request_target event, you need to get the pull request by GitHub API and set the merge commit hash to actions/checkout input ref.

The first two steps are setting up the job's environment. The checkout action will checkout out the repository at the triggering ref. The setup-python action will setup the desired Python runtime. My package supports Python 3.9+ so I'm targeting the minimum version for my build environments.

These first few steps demonstrate how you can run commands like npm install or import other workflows such as how it uses the actions/checkout to copy the contents of the repository into a working directory on the runner host. Read Reusable workflows for more about the syntax for referencing them.

Check out the repo: We will use the actions/checkout action to checkout the repository.

Take a look at the checkout action usage here https://github.com/actions/checkout

Then, we have two important initial steps to define. The first one is an official GitHub Action used to check-out a repository so a workflow can access it. The second one it's pretty more complex but, briefly, downloads and set up a requested version of Java.

publish_report: name: Publish HTML Report # using always() is not ideal here, because it would also run if the workflow was cancelled if: "success() || needs.test.result == 'failure'" needs: [test] runs-on: ubuntu-latest continue-on-error: true env: # Unique URL path for each workflow run attempt HTML_REPORT_URL_PATH: reports/${{ github.ref_name }}/${{ github.run_id }}/${{ github.run_attempt }} steps: - name: Checkout GitHub Pages Branch uses: actions/checkout@v2 with: ref: gh-pages - name: Set Git User # see: https://github.com/actions/checkout/issues/13#issuecomment-724415212 run: | git config --global user.name "github-actions[bot]" git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" - name: Download zipped HTML report uses: actions/download-artifact@v2 with: name: playwright-report path: ${{ env.HTML_REPORT_URL_PATH }} - name: Push HTML Report timeout-minutes: 3 # commit report, then try push-rebase-loop until it's able to merge the HTML report to the gh-pages branch # this is necessary when this job is running at least twice at the same time (e.g. through two pushes at the same time) run: | git add . git commit -m "workflow: add HTML report for run-id ${{ github.run_id }} (attempt: ${{ github.run_attempt }})" while true; do git pull --rebase if [ $? -ne 0 ]; then echo "Failed to rebase. Please review manually." exit 1 fi git push if [ $? -eq 0 ]; then echo "Successfully pushed HTML report to repo." exit 0 fi done - name: Output Report URL as Worfklow Annotation run: | FULL_HTML_REPORT_URL=https://ysfaran.github.io/playwright-gh-actions-gh-pages/$HTML_REPORT_URL_PATH echo "::notice title=📋 Published Playwright Test Report::$FULL_HTML_REPORT_URL"

Ther very first step is actions/checkout@v2 action, which take the latest code from the master branch.

Actions are the smallest portable building blocks of a workflow, which you include as a step. The popular one is actions/checkout@v3, which you use to check out the current repository.