Fix broken brew release process #1211

micahellison · 2021-03-06T21:36:20Z

Our brew release process broke a while back due to us using an unsupported feature in brew bump-formula-pr which stopped working. This PR works around it.

See background in Homebrew issue 10733. Big thanks to @Rylan12 for support on this issue. I ended up working around this by tapping the formula, then working in the tap directory.

Checklist

I have read the contributing doc.
[n/a] I have included a link to the relevant issue number.
[n/a] I have tested this code locally.
I have checked to ensure there aren't other open pull requests
for the same issue.
[n/a] I have written new tests for these changes, as needed.
All tests pass.

wren

🏭

Rylan12

This looks fine to me. The only thing I'd say is that the Homebrew/actions/setup-homebrew action will handle a lot of this for you. It may be worth taking a look to see if that's easier. If not, though, I think this will work just fine so I wouldn't worry about it.

Just a few comments:

Rylan12 · 2021-03-06T21:48:42Z

.github/workflows/release.yaml

+      run: |
+        brew tap ${FORMULA_REPO}
+        echo '::debug::Set tap directory'
+        echo "BREW_TAP_DIRECTORY='$(brew --repository)/Library/Taps/${FORMULA_REPO}'" >> $GITHUB_ENV


Suggested change

echo "BREW_TAP_DIRECTORY='$(brew --repository)/Library/Taps/${FORMULA_REPO}'" >> $GITHUB_ENV

echo "BREW_TAP_DIRECTORY='$(brew --repository ${FORMULA_REPO})'" >> $GITHUB_ENV

brew --repository OWNER/TAP or brew --repository OWNER/homebrew-TAP will return the whole $(brew --repository)/Library/Taps/OWNER/homebrew-TAP path for you.

Rylan12 · 2021-03-06T21:51:40Z

.github/workflows/release.yaml

@@ -202,7 +204,7 @@ jobs:
        max_attempts: 6
        retry_wait_seconds: 30
        command: >
-          brew bump-formula-pr "Formula/${FORMULA_NAME}.rb"
+          brew bump-formula-pr "${FORMULA_NAME}"


This should work fine. You could also use "${FORMULA_REPO}/${FORMULA_NAME}" to always ensure that you specify the right formula. On the off chance that a formula called jrnl-beta is added to Homebrew/core, this might no longer work as expected. I doubt that will happen, though, so probably not worth worrying about.

Add pypi links for documentation, issue tracking, and funding (jrnl-org#1204) Update changelog [ci skip] Fix bug that prevented --format pretty and --format short from working (jrnl-org#1177) Update changelog [ci skip] Fix broken brew release process (jrnl-org#1211) * Add homebrew symlink for releases * Fix indentation problem * Fix bad env var name * Change filename to formula name * Fix formula name * Attempt tap instead of symlink * Fix formula repo referece * add tracer * Attempt working directory fix * Remove --unshallow * Use token for remote * Move set tap directory step * Remove tracer * Clean up spacing and wrap quotes to tap directory Remove global flag from git config Add --local flag in git config calls Increment version to v2.7.2-beta Bump keyring from 22.3.0 to 23.0.0 (jrnl-org#1213) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.0. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Increment version to v2.8-beta Changelog generator fixes There were several problems that this fixes: - shallow fetch broke merging to release branch - bad changelog was only outputting error msg (not exiting) - latest version being on first line deleted itself and broke the changelog updates This also has manual fixes to the changelog to bring it up to date. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Bump pyflakes from 2.2.0 to 2.3.0 (jrnl-org#1215) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Change PR steps for brew release The hub cli tool wasn't working anymore, so we took it out. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Update changelog [ci skip]

Add pypi links for documentation, issue tracking, and funding (jrnl-org#1204) Update changelog [ci skip] Fix bug that prevented --format pretty and --format short from working (jrnl-org#1177) Update changelog [ci skip] Fix broken brew release process (jrnl-org#1211) * Add homebrew symlink for releases * Fix indentation problem * Fix bad env var name * Change filename to formula name * Fix formula name * Attempt tap instead of symlink * Fix formula repo referece * add tracer * Attempt working directory fix * Remove --unshallow * Use token for remote * Move set tap directory step * Remove tracer * Clean up spacing and wrap quotes to tap directory Remove global flag from git config Add --local flag in git config calls Increment version to v2.7.2-beta Bump keyring from 22.3.0 to 23.0.0 (jrnl-org#1213) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.0. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Increment version to v2.8-beta Changelog generator fixes There were several problems that this fixes: - shallow fetch broke merging to release branch - bad changelog was only outputting error msg (not exiting) - latest version being on first line deleted itself and broke the changelog updates This also has manual fixes to the changelog to bring it up to date. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Bump pyflakes from 2.2.0 to 2.3.0 (jrnl-org#1215) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Change PR steps for brew release The hub cli tool wasn't working anymore, so we took it out. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Update changelog [ci skip] Bump cryptography from 3.4.6 to 3.4.7 (#28) Bumps [cryptography](https://github.com/pyca/cryptography) from 3.4.6 to 3.4.7. - [Release notes](https://github.com/pyca/cryptography/releases) - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@3.4.6...3.4.7) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump keyring from 22.3.0 to 23.0.1 (#27) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.1. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump pyflakes from 2.2.0 to 2.3.1 (#26) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.1. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

FIrst pass at allow external plugins remove template exporter Add listing of active plugins to '--version' output Documentation for plugins [Docs] add custom imports and exporters to site TOC [Docs] better linewrapping Include dates_exporter Use Base classes for importer and exporters. [Docs] improve documentation of custom Importers and Exporters [Testing] separate run with external plugin! Bump keyring from 22.3.0 to 23.0.0 (jrnl-org#1213) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.0. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Increment version to v2.8-beta Changelog generator fixes There were several problems that this fixes: - shallow fetch broke merging to release branch - bad changelog was only outputting error msg (not exiting) - latest version being on first line deleted itself and broke the changelog updates This also has manual fixes to the changelog to bring it up to date. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Bump pyflakes from 2.2.0 to 2.3.0 (jrnl-org#1215) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Change PR steps for brew release The hub cli tool wasn't working anymore, so we took it out. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Update changelog [ci skip] Increment version to v2.8 Update changelog [ci skip] Update brew tap for release pipeline This was left out of a previous commit. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Docs: Add emacs as external editor to recipes (jrnl-org#1220) Add emacs as external editor to recipes Bump cryptography from 3.4.6 to 3.4.7 (jrnl-org#1223) Bumps [cryptography](https://github.com/pyca/cryptography) from 3.4.6 to 3.4.7. - [Release notes](https://github.com/pyca/cryptography/releases) - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@3.4.6...3.4.7) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Update changelog [ci skip] Bump pyflakes from 2.3.0 to 2.3.1 (jrnl-org#1221) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.3.0 to 2.3.1. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.3.0...2.3.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump keyring from 23.0.0 to 23.0.1 (jrnl-org#1222) Bumps [keyring](https://github.com/jaraco/keyring) from 23.0.0 to 23.0.1. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v23.0.0...v23.0.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump pytest from 6.2.2 to 6.2.3 (jrnl-org#1228) Bumps [pytest](https://github.com/pytest-dev/pytest) from 6.2.2 to 6.2.3. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest@6.2.2...6.2.3) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Update changelog [ci skip] Update changelog [ci skip] More graceful handling of low linewrap values (jrnl-org#1219) * behavior outline * enforce positive initial linewrap Check column widths update gitignore throw error when linewrap too small simply check for large enough linewrap value * delete unused error message * PR feedback make exception more informative update check_linewrap signature in src and test make check_linewrap a free function * delete unused function * delete else..pass block * newline for make format Update changelog [ci skip] merge from upstream Add pypi links for documentation, issue tracking, and funding (jrnl-org#1204) Update changelog [ci skip] Fix bug that prevented --format pretty and --format short from working (jrnl-org#1177) Update changelog [ci skip] Fix broken brew release process (jrnl-org#1211) * Add homebrew symlink for releases * Fix indentation problem * Fix bad env var name * Change filename to formula name * Fix formula name * Attempt tap instead of symlink * Fix formula repo referece * add tracer * Attempt working directory fix * Remove --unshallow * Use token for remote * Move set tap directory step * Remove tracer * Clean up spacing and wrap quotes to tap directory Remove global flag from git config Add --local flag in git config calls Increment version to v2.7.2-beta Bump keyring from 22.3.0 to 23.0.0 (jrnl-org#1213) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.0. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Increment version to v2.8-beta Changelog generator fixes There were several problems that this fixes: - shallow fetch broke merging to release branch - bad changelog was only outputting error msg (not exiting) - latest version being on first line deleted itself and broke the changelog updates This also has manual fixes to the changelog to bring it up to date. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Bump pyflakes from 2.2.0 to 2.3.0 (jrnl-org#1215) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Change PR steps for brew release The hub cli tool wasn't working anymore, so we took it out. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> Update changelog [ci skip] Bump cryptography from 3.4.6 to 3.4.7 (#28) Bumps [cryptography](https://github.com/pyca/cryptography) from 3.4.6 to 3.4.7. - [Release notes](https://github.com/pyca/cryptography/releases) - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@3.4.6...3.4.7) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump keyring from 22.3.0 to 23.0.1 (#27) Bumps [keyring](https://github.com/jaraco/keyring) from 22.3.0 to 23.0.1. - [Release notes](https://github.com/jaraco/keyring/releases) - [Changelog](https://github.com/jaraco/keyring/blob/main/CHANGES.rst) - [Commits](jaraco/keyring@v22.3.0...v23.0.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump pyflakes from 2.2.0 to 2.3.1 (#26) Bumps [pyflakes](https://github.com/PyCQA/pyflakes) from 2.2.0 to 2.3.1. - [Release notes](https://github.com/PyCQA/pyflakes/releases) - [Changelog](https://github.com/PyCQA/pyflakes/blob/master/NEWS.rst) - [Commits](PyCQA/pyflakes@2.2.0...2.3.1) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

micahellison added 13 commits March 6, 2021 10:58

Add homebrew symlink for releases

3020bd5

Fix indentation problem

7a86f79

Fix bad env var name

b0b5f5d

Change filename to formula name

9f08070

Fix formula name

3cfbf30

Attempt tap instead of symlink

5b40df4

Fix formula repo referece

9ee519b

add tracer

2354f2f

Attempt working directory fix

87b5e1c

Remove --unshallow

c5b99f4

Use token for remote

1d2ab3f

Move set tap directory step

36cf7f1

Remove tracer

c4e1ae7

micahellison added the build Issues related to the build pipeline label Mar 6, 2021

Clean up spacing and wrap quotes to tap directory

9eb9990

wren approved these changes Mar 6, 2021

View reviewed changes

wren merged commit 06e5b4b into jrnl-org:develop Mar 6, 2021

Rylan12 approved these changes Mar 6, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken brew release process #1211

Fix broken brew release process #1211

micahellison commented Mar 6, 2021 •

edited

Loading

wren left a comment

Rylan12 left a comment

Rylan12 Mar 6, 2021

Rylan12 Mar 6, 2021

	echo "BREW_TAP_DIRECTORY='$(brew --repository)/Library/Taps/${FORMULA_REPO}'" >> $GITHUB_ENV
	echo "BREW_TAP_DIRECTORY='$(brew --repository ${FORMULA_REPO})'" >> $GITHUB_ENV

Fix broken brew release process #1211

Fix broken brew release process #1211

Conversation

micahellison commented Mar 6, 2021 • edited Loading

Checklist

wren left a comment

Choose a reason for hiding this comment

Rylan12 left a comment

Choose a reason for hiding this comment

Rylan12 Mar 6, 2021

Choose a reason for hiding this comment

Rylan12 Mar 6, 2021

Choose a reason for hiding this comment

micahellison commented Mar 6, 2021 •

edited

Loading