Release document generation failure

[dixonjoel]

@mshafer-NI the release step failed trying to push the change to main. Do you know how to get around this?

[mshafer-NI]

I'll take a look at the release pipeline to see what's different from the ni-python-styleguide repo.

[mshafer-NI]

This is the only part that is different that I would expect to be related:

---  6/20/2022  9:12:24 AM https://github.com/ni/python-styleguide/blob/main/.github/workflows/Publish-Package.yml
+++  6/20/2022  9:12:24 AM https://github.com/ni/measurement-services-python/blob/main/.github/workflows/Publish.yml
@@ -1,6 +1,2 @@
     steps:
       - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.event.release.target_commitish }} # This is the branch the release was created from. Normally main, but can be a dev branch
-          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
-          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
...

I can't actually see the branch protection setting on either this repo or on ni-python-styleguide, but these are the settings I'm using on a personal repo that I use in a similar release pipeline on:

I know that you NEED "include admins" unchecked, but I'm not sure about "require PR" or "require status checks".

Alternatively, this GH-action says it can get around this by temporarily changing policies: https://github.com/marketplace/actions/push-to-status-check-protected-branches#pat-user-permissions - but if opting to use this, make sure to read through the code first and use a specific version: https://github.com/CasperWA/push-protected/tree/main/push_action

[dixonjoel]

@Vasantha-Kumar-J is checking on the usage of the Admin PAT, so I believe we're trying the alternate you suggested. I'm not sure if we're using that specific version you mentioned. Vasanth can check on that as well.

[Vasantha-Kumar-J]

• In Publish.yml , ADMIN_PAT was used with ad-m/github-push-action@master
• Now I have updated the Publish.yml to use ADMIN_PAT with CasperWA/[email protected] in this commit :c44bf57

After the above changes, I have made test releases and the Publish.yml workflow is running successfully with our repo's custom configuration of branch protection rule where we have "require PR" or "require status checks" enabled.

[Vasantha-Kumar-J]

Now the gh-page for our documentation is available for validation : https://symmetrical-journey-236e860a.pages.github.io/

[Vasantha-Kumar-J]

FYI, @Tharun-Sundar