Skip to content

chore(ci): bump package version after release via pull request #2239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 12, 2023
Merged

chore(ci): bump package version after release via pull request #2239

Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
defe5e7
chore: convert create-pr steps into composite action
heitorlessa May 11, 2023
b36dea7
chore(ci): changelog to use new create-pr action
heitorlessa May 11, 2023
2ca2f0e
chore(ci): revert changelog to trigger on push
heitorlessa May 11, 2023
3905a4c
chore: document custom action
heitorlessa May 11, 2023
0d53e16
chore: add support for any target branch
heitorlessa May 11, 2023
e391610
chore: create a PR to bump version after release
heitorlessa May 11, 2023
5347f64
chore: write permission is no longer necessary
heitorlessa May 11, 2023
f847b85
chore: remove changelog from release
heitorlessa May 11, 2023
c93aeb7
Merge branch 'develop' into chore/bump-release-version-pr
heitorlessa May 12, 2023
3649b0f
chore: address leandro's feedback
heitorlessa May 12, 2023
67a35f6
chore: address leandro's feedback
heitorlessa May 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
build:
runs-on: aws-lambda-powertools_ubuntu-latest_4-core
permissions:
contents: write
contents: read
outputs:
RELEASE_VERSION: ${{ steps.release_version.outputs.RELEASE_VERSION }}
env:
Expand Down Expand Up @@ -79,13 +79,6 @@ jobs:
- name: Run all tests, linting and baselines
if: ${{ !inputs.skip_code_quality }}
run: make pr
- name: Git client setup and refresh tip
run: |
git config user.name "Release bot"
git config user.email "[email protected]"
git config pull.rebase true
git config remote.origin.url >&- || git remote add origin https://github.com/"${ORIGIN}" # Git Detached mode (release notes) doesn't have origin
git pull origin "${BRANCH}"
- name: Bump package version
id: versioning
run: poetry version "${RELEASE_VERSION}"
Expand All @@ -105,16 +98,6 @@ jobs:
# and also future-proof for when we switch to protected branch and update via PR
key: ${{ runner.os }}-${{ env.RELEASE_VERSION }}-${{ hashFiles('**/poetry.lock') }}

- name: Update version in trunk
if: steps.versioning.outcome == 'success'
run: |
HAS_CHANGE=$(git status --porcelain)
test -z "${HAS_CHANGE}" && echo "Nothing to update" && exit 0
git add pyproject.toml
git commit -m "bump version to ${RELEASE_VERSION}" --no-verify
git pull origin "${BRANCH}" # prevents concurrent branch update failing push
git push origin HEAD:refs/heads/"${BRANCH}"

release:
needs: build
environment: release
Expand Down Expand Up @@ -143,12 +126,6 @@ jobs:
# with:
# repository-url: https://test.pypi.org/legacy/

changelog:
needs: release
permissions:
contents: write
uses: ./.github/workflows/reusable_publish_changelog.yml

# NOTE: Watch out for the depth limit of 4 nested workflow_calls.
# publish_layer -> publish_v2_layer -> reusable_deploy_v2_layer_stack -> reusable_update_v2_layer_arn_docs
publish_layer:
Expand All @@ -163,6 +140,28 @@ jobs:
latest_published_version: ${{ needs.build.outputs.RELEASE_VERSION }}
pre_release: ${{ inputs.pre_release }}

bump_version:
needs: [build, release]
permissions:
contents: write
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
contents: write
contents: write # create-pr action creates a temporary branch

pull-requests: write
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these permissions not conflicting with each other? I think the pull-requests: write permission is enough for that, no? The contents: write permission seems to be much broader and allows things we don't need.

References:
https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#pull-requests
https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in this case :)

create-pr action needs to create a temporary branch to push these staged files (pyproject.toml) - hence contents: write. Then, creates a PR against develop using our temporary branch as the HEAD - hence pull-requests: write

runs-on: ubuntu-latest
env:
RELEASE_VERSION: ${{ needs.build.outputs.RELEASE_VERSION }}
steps:
- uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
- name: Bump package version
id: versioning
run: poetry version "${RELEASE_VERSION}"
- name: Create PR
id: create-pr
uses: ./.github/actions/create-pr
with:
files: "pyproject.toml"
temp_branch_prefix: "ci-bump"
pull_request_title: "chore(ci): bump version to ${{ env.RELEASE_VERSION }}"
github_token: ${{ secrets.GITHUB_TOKEN }}

post_release:
needs: [build, release, publish_layer]
permissions:
Expand Down