Refactor release.yml (#4475)

Diana Liskovich · facebook-github-bot · commit 73b42f0f3e39 · 2022-06-11T11:49:18.000-07:00
Summary: # Before submitting - [ ] Was this discussed/approved via a Github issue? (no need for typos, doc improvements) - [ ] Did you read the [contributor guideline](https://github.com/pytorch/fairseq/blob/main/CONTRIBUTING.md)? - [ ] Did you make sure to update the docs? - [ ] Did you write any new necessary tests? ## What does this PR do? Fixes # (issue). ## PR review Anyone in the community is free to review the PR once the tests have passed. If we didn't discuss your PR in Github issues there's a high chance it will not be merged. ## Did you have fun? Make sure you had fun coding � Pull Request resolved: #4475 Reviewed By: anupambhatnagar Differential Revision: D37081823 Pulled By: dianaml0 fbshipit-source-id: b5167aa66e0b873c5f466e1b16a27ca779802780
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,17 +24,74 @@ jobs:
       - name: get next version and tag
         id: get-next-version-and-tag
         run: |
-          output=$(python3 release_utils.py --release-type ${{ github.event.inputs.name }})
+          output=$(python3 release_utils.py --release-type ${{ github.event.inputs.name }}) 
           echo $output
           new_version=$(echo $output | awk '{print $1}')
           new_tag=$(echo $output | awk '{print $2}')
           echo "new version is $new_version"
           echo "new tag is $new_tag"
           echo ::set-output name=version::$new_version
           echo ::set-output name=tag::$new_tag
+          echo ::set-output name=branch_name::$new_version-release
+          echo "NEW_TAG=$new_tag" >> $GITHUB_ENV
+          echo "NEW_BRANCH=$new_version-release" >> $GITHUB_ENV
+
+
+      # update the version number in version.txt
+      - name: update version
+        id: update-version
+        run : |
+          echo "current folder = $PWD"
+          echo "current branch = $(git branch --show-current)"
+          output=$(python3 release_utils.py --release-type ${{ github.event.inputs.name }} --update-version)
+
+      - name: add and commit
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: ${{ secrets.AUTHOR_NAME }}
+          author_email: ${{ secrets.AUTHOR_EMAIL }}
+
+          # TODO: change this to main once shipit is disabled.
+          new_branch: '${{ env.NEW_BRANCH }}'
+          default_author: github_actor
+          message: '${{ env.NEW_TAG }} release'
+          pathspec_error_handling: exitAtEnd
+
+          # Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all.
+          # pull: 'NO-PULL'
+          tag: '${{ env.NEW_TAG }}'
+
     outputs:
       new_version: ${{ steps.get-next-version-and-tag.outputs.version }}
       new_tag: ${{ steps.get-next-version-and-tag.outputs.tag }}
+      branch_name: ${{ steps.get-next-version-and-tag.outputs.branch_name }}
+
+  create_sdist:
+    runs-on: ubuntu-latest
+    name: Create Source Distribution
+    needs: get_next_version
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.get_next_version.outputs.branch_name }}
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: Upgrade pip
+        run: |
+          python3 -m pip install --upgrade pip
+
+      - name: Create Source Distribution
+        run: |
+          pip install setuptools wheel twine
+          python3 setup.py sdist
+ 
+      - uses: actions/upload-artifact@v2
+        with:
+          path: dist/*.tar.gz
 
   build_wheels:
     name: Build wheels on ${{ matrix.os }}
@@ -45,30 +102,19 @@ jobs:
         os: [ubuntu-latest, macos-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.get_next_version.outputs.branch_name }}
 
       - name: Install Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.8'
 
-      # update the version number in version.txt
-      - name: update version
-        id: update-version
-        run : |
-          echo "current folder = $PWD"
-          echo "current branch = $(git branch --show-current)"
-          output=$(python3 release_utils.py --release-type ${{ github.event.inputs.name }} --update-version)
-
       - name: Upgrade pip
         run: |
           python3 -m pip install --upgrade pip
 
-      - name: Create Source Distribution
-        run: |
-          pip install setuptools wheel twine
-          python3 setup.py sdist
-
       - name: Install cibuildwheel
         run: |
           python3 -m pip install cibuildwheel
@@ -85,6 +131,20 @@ jobs:
           CIBW_ENVIRONMENT: "PIP_ONLY_BINARY=numpy"
           CIBW_SKIP: "*musllinux*"
 
+      - uses: actions/upload-artifact@v2
+        with:
+          path: dist
+
+  upload:
+    name: Upload to PyPi and create release
+    runs-on: ubuntu-latest
+    needs: [build_wheels, create_sdist, get_next_version]
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifact
+          path: dist
+
       # build the PyPI package and upload it
       - name: upload
         env:
@@ -93,27 +153,8 @@ jobs:
         run: |
           python3 -m twine upload --repository pypi dist/*
 
-      # add and commit the updated version.py to main
-      - name: add and commit
-        if: ${{ matrix.os=='ubuntu-latest' }}
-        uses: EndBug/add-and-commit@v9
-        with:
-          author_name: ${{ secrets.AUTHOR_NAME }}
-          author_email: ${{ secrets.AUTHOR_EMAIL }}
-
-          # TODO: change this to main once shipit is disabled.
-          new_branch: ${{ needs.get_next_version.outputs.new_version }}
-          default_author: github_actor
-          message: '${{ needs.get_next_version.outputs.new_version }} release'
-          pathspec_error_handling: exitAtEnd
-
-          # Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all.
-          # pull: 'NO-PULL'
-          tag: '${{ needs.get_next_version.outputs.new_tag }}'
-
       # create the release on github
       - name: create release on github
-        if: ${{ matrix.os=='ubuntu-latest' }}
         uses: ncipollo/release-action@v1
         with:
           tag: '${{ needs.get_next_version.outputs.new_tag }}'
diff --git a/RELEASE.md b/RELEASE.md
@@ -6,7 +6,7 @@ In order to create a new release:
 
 2. Under _Run Workflow_ choose the branch `main` and for _Release Type_ enter either `major`, `minor`, or `patch`.  
 
-3. A branch with the same name as the new version will be created where the `version.txt` file is updated. Merge those changes into `main`.
+3. A branch named `$new_version-release` will be created where the `version.txt` file is updated. Merge those changes into `main`.
 
 4. Make sure that a [new PYPI package](https://pypi.org/project/fairseq/) has been uploaded.
 
