Update/set output (#90)

* updating set-output to echo to $GITHUB_OUTPUT instead Signed-off-by: vsoch <vsoch@users.noreply.github.com>
2022-10-25 21:00:21 -06:00
parent d703f40f3a
commit 50f22f6d14
9 changed files with 110 additions and 113 deletions
--- a/README.md
+++ b/README.md
@@ -100,7 +100,9 @@ The screenshot below shows the example in action to interact with outputs in sev
 ## Examples

 Example workflows are provided in [examples](examples), and please contribute any
-examples that you might have to help other users! We will walk through a basic
+examples that you might have to help other users! You can get the same commit hashes
+and commented tags if you use the [action-updater](https://github.com/vsoch/action-updater)
+also maintained by @vsoch. We will walk through a basic
 example here for a niche case. Let's say that we are opening a pull request on the release event. This would mean
 that the payload's branch variable would be null. We would need to define `PULL_REQUEST_FROM`. How would
 we do that? We can [set environment variables](https://github.com/actions/toolkit/blob/main/docs/commands.md#environment-files) for next steps. Here is an example:
--- a/examples/assignees-example.yml
+++ b/examples/assignees-example.yml
@@ -9,9 +9,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
        PULL_REQUEST_ASSIGNEES: vsoch
--- a/examples/branch-from-environment.yml
+++ b/examples/branch-from-environment.yml
@@ -1,16 +1,15 @@
 name: derive-branch-from-environment

 on:
-  schedule:
-    # Weekly
-    - cron: 0 0 * * 0
+  schedule: -
+    cron: 0 0 * * 0

 jobs:
  DoSomeUpdate:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repository
-      uses: actions/checkout@v1
+      uses: actions/checkout@v3
    - name: Install or Do Something to Change repository
      run: |
        echo "This is a new file." >> newfile.txt
@@ -18,7 +17,7 @@ jobs:
    - name: Checkout New Branch
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        BRANCH_AGAINST: "master"
+        BRANCH_AGAINST: master
      run: |
        printf "GitHub Actor: ${GITHUB_ACTOR}\n"
        export BRANCH_FROM="update/newfile-$(date '+%Y-%m-%d')"
@@ -43,7 +42,7 @@ jobs:
        echo "PULL_REQUEST_FROM_BRANCH=${BRANCH_FROM}" >> $GITHUB_ENV

    - name: Open Pull Request
-      uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_BRANCH: "master"
+        PULL_REQUEST_BRANCH: master
--- a/examples/custom-body-example.yml
+++ b/examples/custom-body-example.yml
@@ -13,7 +13,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: Generate branch name
-        uses: actions/github-script@v3
+      uses: actions/github-script@v6
      id: set-branch-name
      with:
        script: |
@@ -34,7 +34,7 @@ jobs:
    - name: Set branch name
      run: echo "PULL_REQUEST_TITLE=${{steps.set-branch-name.outputs.result}}" >> $GITHUB_ENV
    - name: Generate PR body
-        uses: actions/github-script@v3
+      uses: actions/github-script@v6
      id: set-pr-body
      with:
        script: |
@@ -47,9 +47,9 @@ jobs:
    - name: Set PR body
      run: echo "PULL_REQUEST_BODY=${{steps.set-pr-body.outputs.result}}" >> $GITHUB_ENV
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "hotfix-"
-          PULL_REQUEST_BRANCH: "production"
-          PULL_REQUEST_REVIEWERS: "AnandChowdhary"
+        BRANCH_PREFIX: hotfix-
+        PULL_REQUEST_BRANCH: production
+        PULL_REQUEST_REVIEWERS: AnandChowdhary
--- a/examples/outputs-example.yml
+++ b/examples/outputs-example.yml
@@ -10,11 +10,11 @@ jobs:
    steps:
    - name: pull-request-action
      id: pull_request
-        uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
        PULL_REQUEST_REVIEWERS: vsoch
    - name: Test outputs
      env:
--- a/examples/push-example.yml
+++ b/examples/push-example.yml
@@ -11,8 +11,8 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
--- a/examples/release-example.yml
+++ b/examples/release-example.yml
@@ -18,31 +18,27 @@ jobs:
        version=$(echo "$tag_name" | sed 's/^v//')
        echo "Version: $version"

-        echo "::set-output name=suite_version::${version}"
-        echo "::set-output name=suite_update_branch::suite_${version}"
+        echo "suite_version=${version}" >> $GITHUB_OUTPUT
+        echo "suite_update_branch=suite_${version}" >> $GITHUB_OUTPUT
      id: data

    - name: Permanently save the new suite release
      run: |
        mkdir -p releases
-
        new_suite_version_yml="releases/suite_${{ steps.data.outputs.suite_version }}.yml"
        echo "Suite target file: $new_suite_version_yml"
-
        cp suite.yml "${new_suite_version_yml}"
-
        git add "${new_suite_version_yml}"
        git commit -m "Suite v${{ steps.data.outputs.suite_version }} auto-commit of new release files"

    - name: Push files
-      run: |
-        git push --force "https://${{ github.actor }}:${{secrets.GITHUB_TOKEN}}@github.com/${{ github.repository }}.git" "HEAD:${{ steps.data.outputs.suite_update_branch }}"
+      run: git push --force "https://${{ github.actor }}:${{secrets.GITHUB_TOKEN}}@github.com/${{ github.repository }}.git" "HEAD:${{ steps.data.outputs.suite_update_branch }}"

    - name: Open a PR to the default branch
-      uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_FROM_BRANCH: "${{ steps.data.outputs.suite_update_branch }}"
+        PULL_REQUEST_FROM_BRANCH: ${{ steps.data.outputs.suite_update_branch }}
        PULL_REQUEST_BRANCH: master
-        PULL_REQUEST_TITLE: "Action: Update suite release file for v${{ steps.data.outputs.suite_version }}"
-        PULL_REQUEST_BODY: "Auto-generated PR!"
+        PULL_REQUEST_TITLE: 'Action: Update suite release file for v${{ steps.data.outputs.suite_version }}'
+        PULL_REQUEST_BODY: Auto-generated PR!
--- a/examples/reviewers-example.yml
+++ b/examples/reviewers-example.yml
@@ -9,9 +9,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: pull-request-action
-        uses: vsoch/pull-request-action@master
+      uses: vsoch/pull-request-action@d703f40f3af5ae294f9816395ddf2e3d2d3feafa # 1.0.21
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"
+        BRANCH_PREFIX: update/
+        PULL_REQUEST_BRANCH: master
        PULL_REQUEST_REVIEWERS: vsoch
--- a/pull-request.py
+++ b/pull-request.py
@@ -160,11 +160,11 @@ def set_pull_request_groups(response):
    html_url = response.get("html_url")
    print("Number opened for PR is %s" % number)
    set_env("PULL_REQUEST_NUMBER", number)
-    print("::set-output name=pull_request_number::%s" % number)
+    print("pull_request_number=%s >> $GITHUB_OUTPUT" % number)
    set_env("PULL_REQUEST_RETURN_CODE", pull_request_return_code)
-    print("::set-output name=pull_request_return_code::%s" % pull_request_return_code)
+    print("pull_request_return_code=%s >> $GITHUB_OUTPUT" % pull_request_return_code)
    set_env("PULL_REQUEST_URL", html_url)
-    print("::set-output name=pull_request_url::%s" % html_url)
+    print("pull_request_url=%s >> $GITHUB_OUTPUT" % html_url)


 def list_pull_requests(target, source):
@@ -216,7 +216,7 @@ def add_assignees(entry, assignees):
    print(response.json())
    print("::endgroup::github assignees response")
    set_env("ASSIGNEES_RETURN_CODE", assignees_return_code)
-    print("::set-output name=assignees_return_code::%s" % assignees_return_code)
+    print("assignees_return_code=%s >> $GITHUB_OUTPUT" % assignees_return_code)


 def find_pull_request(listing, source):
@@ -273,7 +273,7 @@ def add_reviewers(entry, reviewers, team_reviewers):
    print(response.json())
    print("::endgroup::github reviewers response")
    set_env("REVIEWERS_RETURN_CODE", reviewers_return_code)
-    print("::set-output name=reviewers_return_code::%s" % reviewers_return_code)
+    print("reviewers_return_code=%s >> $GITHUB_OUTPUT" % reviewers_return_code)
    print("Add reviewers return code: %s" % reviewers_return_code)