Skip to content

Commit 4bee8cb

Browse files
committed
chore(ci): make release process manual
1 parent 9025f04 commit 4bee8cb

File tree

1 file changed

+14
-26
lines changed

1 file changed

+14
-26
lines changed

Diff for: .github/workflows/on_release_notes.yml renamed to .github/workflows/release.yml

+14-26
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,28 @@
1-
name: Publish to PyPi
1+
name: Release
22

33
# RELEASE PROCESS
44
#
5+
# === Automated activities ===
6+
#
7+
# 1. Run tests, linting, security and complexity base line
8+
# 2. Bump package version and generate latest Changelog
9+
# 3. Publish package to PyPi test and prod repository
10+
# 4. Kick off SAR App pipeline to publish latest version with minimal and extra dependencies
11+
# 5. Builds and publish latest changelog from tip of the branch
12+
# 6. Builds a new user guide and API docs with release version; update /latest pointing to newly released version
13+
# 7. Close all issues labeled "pending-release" and notify customers about the release
14+
#
515
# === Manual activities ===
616
#
717
# 1. Edit the current draft release notes
818
# 2. If not already set, use `v<new version>` as a tag, e.g., v1.26.4, and select develop as target branch
9-
#
10-
# === Automated activities ===
11-
#
12-
# 1. Extract release notes tag that was published
13-
# 2. Run tests, linting, security and complexity base line
14-
# 3. Bump package version and generate latest Changelog
15-
# 4. Publish package to PyPi test and prod repository
16-
# 5. Kick off SAR App pipeline to publish latest version with minimal and extra dependencies
17-
# 6. Builds and publish latest changelog from tip of the branch
18-
# 7. Builds a new user guide and API docs with release version; update /latest pointing to newly released version
19-
# 8. Close all issues labeled "pending-release" and notify customers about the release
2019

2120
# See MAINTAINERS.md "Releasing a new version" for release mechanisms
2221

2322
env:
2423
BRANCH: develop
2524

2625
on:
27-
release:
28-
# We can't filter by tag here, so we filter later on the first job
29-
types: [published]
30-
3126
workflow_dispatch:
3227
inputs:
3328
version_to_publish:
@@ -44,12 +39,6 @@ on:
4439
default: false
4540
type: boolean
4641
required: false
47-
# Only use this until v1 is completely dropped, and for manual releases
48-
skip_version_guard:
49-
description: "Skips conditions to prevent v1 into v2 releases"
50-
default: false
51-
type: boolean
52-
required: false
5342
pre_release:
5443
description: "Publishes documentation using a pre-release tag (v2.0.0a0). You are still responsible for passing a pre-release version tag to the workflow."
5544
default: false
@@ -58,15 +47,14 @@ on:
5847

5948
jobs:
6049
release:
61-
if: ${{ startsWith(github.ref, 'refs/tags/v2') || inputs.skip_version_guard }}
6250
environment: release
6351
runs-on: ubuntu-latest
6452
permissions:
6553
contents: read
6654
outputs:
6755
RELEASE_VERSION: ${{ steps.release_version.outputs.RELEASE_VERSION }}
6856
env:
69-
RELEASE_TAG_VERSION: ${{ github.event.release.tag_name || inputs.version_to_publish }}
57+
RELEASE_TAG_VERSION: ${{ inputs.version_to_publish }}
7058
steps:
7159
- uses: actions/checkout@v3
7260
with:
@@ -76,7 +64,7 @@ jobs:
7664
- name: Set up Python
7765
uses: actions/setup-python@v4
7866
with:
79-
python-version: "3.8"
67+
python-version: "3.9"
8068
cache: "poetry"
8169
- name: Set release notes tag
8270
id: release_version
@@ -128,7 +116,7 @@ jobs:
128116
uses: ./.github/workflows/publish_v2_layer.yml
129117
with:
130118
latest_published_version: ${{ needs.release.outputs.RELEASE_VERSION }}
131-
pre_release: ${{ github.event.release.prerelease || inputs.pre_release }}
119+
pre_release: ${{ inputs.pre_release }}
132120

133121
post_release:
134122
needs: [release, publish_layer]

0 commit comments

Comments
 (0)